subsetCohorts {CohortConstructor} | R Documentation |
Generate a cohort table keeping a subset of cohorts.
Description
subsetCohorts()
filters an existing cohort table, keeping only the records
from cohorts that are specified.
Usage
subsetCohorts(
cohort,
cohortId,
name = tableName(cohort),
.softValidation = TRUE
)
Arguments
cohort |
A cohort table in a cdm reference. |
cohortId |
Vector identifying which cohorts to include (cohort_definition_id or cohort_name). Cohorts not included will be removed from the cohort set. |
name |
Name of the new cohort table created in the cdm object. |
.softValidation |
Whether to perform a soft validation of consistency. If set to FALSE four additional checks will be performed: 1) a check that cohort end date is not before cohort start date, 2) a check that there are no missing values in required columns, 3) a check that cohort duration is all within observation period, and 4) that there are no overlapping cohort entries |
Value
Cohort table with only cohorts in cohortId.
Examples
library(CohortConstructor)
cdm <- mockCohortConstructor(nPerson = 100)
cdm$cohort1 |> subsetCohorts(cohortId = 1)
[Package CohortConstructor version 0.4.0 Index]