requireSex {CohortConstructor}

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

Arguments

cohort

A cohort table in a cdm reference.

sex

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

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.

name

Name of the new cohort with the sex requirements.

Value

The cohort table with only records for individuals satisfying the sex requirement

Examples

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