trimDemographics: Trim cohort on patient demographics

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

Trim 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),
  .softValidation = TRUE
)

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.
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.
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

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)))

CohortConstructor documentation built on June 8, 2025, 12:49 p.m.