Skip to contents

Create a container criterion for an observer

create_descriptor_condition.Rd

Build a single DescriptorCondition entry for an Observer's ContainerCriteria. A container criterion matches the containers an observer applies to by a Tag and an optional match Type. This is a small builder that returns the raw named list; assemble several of them into a list for create_observer() or observer$container_criteria.

Usage

create_descriptor_condition(tag, type = NULL)

Arguments

tag

Character. The container tag to match (required).

type

Character. The match type. This is an open string, not a closed enum: PK-Sim writes values such as "InContainer", "NotInContainer", "InParent", or "MatchTag", and any of these (or another string PK-Sim emits) is preserved verbatim. Omitted when NULL.

Value

A named list with Tag and, when supplied, Type.

Examples

create_descriptor_condition("Brain", "InContainer")
#> $Tag
#> [1] "Brain"
#> 
#> $Type
#> [1] "InContainer"
#> 

# The match type is optional
create_descriptor_condition("Brain")
#> $Tag
#> [1] "Brain"
#>