Set cohort start or cohort end
Usage
padCohortDate(
cohort,
days,
cohortDate = "cohort_start_date",
indexDate = "cohort_start_date",
collapse = TRUE,
padObservation = TRUE,
cohortId = NULL,
name = tableName(cohort),
.softValidation = FALSE
)Arguments
- cohort
A cohort table in a cdm reference.
- days
Integer with the number of days to add or name of a column (that must be numeric) to add.
- cohortDate
'cohort_start_date' or 'cohort_end_date'.
- indexDate
Variable in cohort that contains the index date to add.
- collapse
Whether to collapse the overlapping records (TRUE) or drop the records that have an ongoing prior record.
- padObservation
Whether to pad observations if they are outside observation_period (TRUE) or drop the records if they are outside observation_period (FALSE)
- 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.
- .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
Examples
# \donttest{
library(CohortConstructor)
cdm <- mockCohortConstructor()
cdm$cohort1 |>
padCohortDate(
cohortDate = "cohort_end_date",
indexDate = "cohort_start_date",
days = 10)
#> # Source: table<cohort1> [?? x 4]
#> # Database: DuckDB v1.3.2 [unknown@Linux 6.11.0-1018-azure:R 4.5.1/:memory:]
#> cohort_definition_id subject_id cohort_start_date cohort_end_date
#> <int> <int> <date> <date>
#> 1 1 4 2017-05-07 2017-05-17
#> 2 1 9 2007-03-19 2007-03-29
#> 3 1 3 2007-07-10 2007-07-20
#> 4 1 3 2005-09-25 2005-10-05
#> 5 1 5 2016-11-01 2016-11-11
#> 6 1 6 1994-11-23 1994-12-03
#> 7 1 2 2010-03-30 2010-04-09
#> 8 1 6 2014-10-27 2014-11-06
#> 9 1 3 2007-04-25 2007-05-05
#> 10 1 5 2016-08-28 2016-09-07
# }