unionCohorts: Generate cohort from the union of different cohorts

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

Generate cohort from the union of different cohorts

Description

unionCohorts() combines different cohort entries, with those records that overlap combined and kept. Cohort entries are when an individual was in either of the cohorts.

Usage

unionCohorts(
  cohort,
  cohortId = NULL,
  gap = 0,
  cohortName = NULL,
  keepOriginalCohorts = FALSE,
  name = tableName(cohort),
  .softValidation = TRUE
)

Arguments

cohort	A cohort table in a cdm reference.
cohortId	Vector identifying which cohorts to include (cohort_definition_id or cohort_name). Cohorts not included will be removed from the cohort set.
gap	Number of days between two subsequent cohort entries to be merged in a single cohort record.
cohortName	Name of the returned cohort. If NULL, the cohort name will be created by collapsing the individual cohort names, separated by "_".
keepOriginalCohorts	If TRUE the original cohorts will be return together with the new ones. If FALSE only the new cohort will be returned.
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

A cohort table.

Examples

library(CohortConstructor)

cdm <- mockCohortConstructor(nPerson = 100)

cdm$cohort2 <- cdm$cohort2 |> unionCohorts()
settings(cdm$cohort2)

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