yearCohorts {CohortConstructor} | R Documentation |
Generate a new cohort table restricting cohort entries to certain years
Description
yearCohorts()
splits a cohort into multiple cohorts, one for each year.
Usage
yearCohorts(
cohort,
years,
cohortId = NULL,
name = tableName(cohort),
.softValidation = FALSE
)
Arguments
cohort |
A cohort table in a cdm reference. |
years |
Numeric vector of years to use to restrict observation to. |
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
A cohort table.
Examples
library(CohortConstructor)
cdm <- mockCohortConstructor(nPerson = 100)
cdm$cohort1 <- cdm$cohort1 |> yearCohorts(years = 2000:2002)
settings(cdm$cohort1)
[Package CohortConstructor version 0.4.0 Index]