requireDemographics: Restrict cohort on patient demographics

In CohortConstructor: Build and Manipulate Study Cohorts Using a Common Data Model

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,
  atFirst = FALSE,
  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.
atFirst	If FALSE the requirement will be applied to all records, if TRUE, it will only be required for the first entry of each subject.
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)
if(isTRUE(omock::isMockDatasetDownloaded("GiBleed"))){
cdm <- mockCohortConstructor()

cdm$cohort1 |>
  requireDemographics(indexDate = "cohort_start_date",
                      ageRange = list(c(18, 65)),
                      sex = "Female",
                      minPriorObservation = 365)
}

CohortConstructor documentation built on Nov. 5, 2025, 6:53 p.m.