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.
Examples
# \donttest{
library(CohortConstructor)
cdm <- mockCohortConstructor()
cdm$cohort1 |>
requireSex(sex = "Female")
#> # Source: table<main.cohort1> [8 x 4]
#> # Database: DuckDB v1.1.2 [unknown@Linux 6.5.0-1025-azure:R 4.4.2/:memory:]
#> cohort_definition_id subject_id cohort_start_date cohort_end_date
#> <int> <int> <date> <date>
#> 1 1 2 1964-09-18 1965-08-30
#> 2 1 3 1976-11-28 1977-03-11
#> 3 1 3 1977-03-12 1978-04-03
#> 4 1 3 1978-04-04 1987-02-26
#> 5 1 4 1998-06-22 2001-02-12
#> 6 1 5 2007-10-19 2008-11-10
#> 7 1 5 2008-11-11 2011-09-12
#> 8 1 9 2012-01-18 2012-03-08
# }