requireDemographics {CohortConstructor} | R Documentation |
Restrict cohort on patient demographics
Description
requireDemographics()
filters cohort records, keeping only records where
individuals satisfy the specified demographic criteria.
Usage
requireDemographics(
cohort,
cohortId = NULL,
indexDate = "cohort_start_date",
ageRange = list(c(0, 150)),
sex = c("Both"),
minPriorObservation = 0,
minFutureObservation = 0,
requirementInteractions = TRUE,
name = tableName(cohort)
)
Arguments
cohort |
A cohort table in a cdm reference. |
cohortId |
Vector identifying which cohorts to modify (cohort_definition_id or cohort_name). If NULL, all cohorts will be used; otherwise, only the specified cohorts will be modified, and the rest will remain unchanged. |
indexDate |
Variable in cohort that contains the date to compute the demographics characteristics on which to restrict on. |
ageRange |
A list of vectors specifying minimum and maximum age. |
sex |
Can be "Both", "Male" or "Female". |
minPriorObservation |
A minimum number of continuous prior observation days in the database. |
minFutureObservation |
A minimum number of continuous future observation days in the database. |
requirementInteractions |
If TRUE, cohorts will be created for all combinations of ageGroup, sex, and daysPriorObservation. If FALSE, only the first value specified for the other factors will be used. Consequently, order of values matters when requirementInteractions is FALSE. |
name |
Name of the new cohort table created in the cdm object. |
Value
The cohort table with only records for individuals satisfying the demographic requirements
Examples
library(CohortConstructor)
cdm <- mockCohortConstructor(nPerson = 100)
cdm$cohort1 |>
requireDemographics(indexDate = "cohort_start_date",
ageRange = list(c(18, 65)),
sex = "Female",
minPriorObservation = 365)