Set a cohort filter on the plan

Attaches a cohort definition to the plan, restricting all downstream outputs to the selected cohort episodes. A person may therefore contribute multiple episodes under the same definition, including overlapping episodes. Exactly one of cohort_definition_id or spec must be provided. Use cohort_definition_id to reference an existing cohort definition, or spec to define a cohort inline using the DSL.

Usage

ds.omop.plan.cohort(plan, cohort_definition_id = NULL, spec = NULL)

Arguments

plan

An omop_plan object.

cohort_definition_id

Integer; ID of an existing cohort in the cohort table. Mutually exclusive with spec.

spec

Named list; inline cohort specification DSL describing inclusion criteria. Mutually exclusive with cohort_definition_id.

Value

The modified omop_plan with the cohort slot populated.

See also

ds.omop.plan, ds.omop.plan.cohort_membership

Examples

if (FALSE) { # \dontrun{
plan <- ds.omop.plan()
plan <- ds.omop.plan.cohort(plan, cohort_definition_id = 42)

# Or with an inline spec
plan <- ds.omop.plan.cohort(plan, spec = list(
  sex = "Female", age_range = c(40, 65)
))
} # }