requireSex: Restrict cohort on sex

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

Restrict cohort on sex

Description

requireSex() filters cohort records, keeping only records where individuals satisfy the specified sex criteria.

Usage

requireSex(
  cohort,
  sex,
  cohortId = NULL,
  name = tableName(cohort),
  .softValidation = TRUE
)

Arguments

cohort	A cohort table in a cdm reference.
sex	Can be "Both", "Male" or "Female".
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.
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 sex requirement

Examples

library(CohortConstructor)
cdm <- mockCohortConstructor()
cdm$cohort1 |>
  requireSex(sex = "Female")

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