Restrict cohort on sex

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

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.

Value

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

Examples

# \donttest{
library(CohortConstructor)
cdm <- mockCohortConstructor()
cdm$cohort1 |>
  requireSex(sex = "Female")
#> # Source:   table<main.cohort1> [5 x 4]
#> # Database: DuckDB v1.0.0 [unknown@Linux 6.5.0-1025-azure:R 4.4.1/:memory:]
#>   cohort_definition_id subject_id cohort_start_date cohort_end_date
#>                  <int>      <int> <date>            <date>         
#> 1                    1          2 2000-05-04        2000-05-17     
#> 2                    1          2 2000-05-18        2001-01-23     
#> 3                    1          3 2015-01-27        2015-06-28     
#> 4                    1          5 2012-03-20        2012-04-30     
#> 5                    1          5 2012-05-01        2012-07-24     
# }