copyCohorts: Copy a cohort table

View source: R/copyCohorts.R

copyCohortsR Documentation

Copy a cohort table

Description

copyCohorts() copies an existing cohort table to a new location.

Usage

copyCohorts(cohort, name, n = 1, cohortId = NULL, .softValidation = TRUE)

Arguments

cohort

A cohort table in a cdm reference.

name

Name of the new cohort table created in the cdm object.

n

Number of times to duplicate the selected cohorts.

cohortId

Vector identifying which cohorts to include (cohort_definition_id or cohort_name). Cohorts not included will be removed from the cohort set.

.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 new cohort table containing cohorts from the original cohort table.

Examples


library(CohortConstructor)
cdm <- mockCohortConstructor()
cdm$cohort3 <- copyCohorts(cdm$cohort1, n = 2, cohortId = 1, name = "cohort3")


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