trimDemographics {CohortConstructor}

Restrict cohort on patient demographics

Description

trimDemographics() resets the cohort start and end date based on the specified demographic criteria is satisfied.

Usage

trimDemographics(
  cohort,
  cohortId = NULL,
  ageRange = NULL,
  sex = NULL,
  minPriorObservation = NULL,
  minFutureObservation = NULL,
  name = tableName(cohort)
)

Arguments

cohort

A cohort table in a cdm reference.

cohortId

IDs of the cohorts to modify. If NULL, all cohorts will be used; otherwise, only the specified cohorts will be modified, and the rest will remain unchanged.

ageRange

A list of minimum and maximum age.

sex

Can be "Both", "Male" or "Female". If one of the latter, only those with that sex will be included.

minPriorObservation

A minimum number of prior observation days in the database.

minFutureObservation

A minimum number of future observation days in the database.

name

Name of the new cohort with the demographic requirements.

Value

The cohort table with only records for individuals satisfying the demographic requirements

Examples

library(CohortConstructor)

cdm <- mockCohortConstructor(nPerson = 100)

cdm$cohort1 |> trimDemographics(ageRange = list(c(10, 30)))