CohortConstructor (version 0.6.1)

trimToDateRange: Trim cohort dates to be within a date range

Description

trimToDateRange() resets the cohort start and end date based on the specified date range.

Usage

trimToDateRange(
  cohort,
  dateRange,
  cohortId = NULL,
  startDate = "cohort_start_date",
  endDate = "cohort_end_date",
  name = tableName(cohort),
  .softValidation = FALSE
)

Value

The cohort table with record timings updated to only be within the date range. Any records with all time outside of the range will have been dropped.

Arguments

cohort

A cohort table in a cdm reference.

dateRange

A window of time during which the start and end date must have been observed.

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.

startDate

Variable with earliest date.

endDate

Variable with latest date.

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$cohort2 <- cdm$cohort1 |>
  trimToDateRange(
    startDate = "cohort_start_date",
    endDate = "cohort_end_date",
    dateRange = as.Date(c("2015-01-01", "2015-12-31")),
    name = "cohort2"
  )

cdm$cohort1 <- cdm$cohort1 |>
  trimToDateRange(
    dateRange = as.Date(c(NA, "2015-12-31"))
  )
# }