trimToDateRange {CohortConstructor} | R Documentation |
trimToDateRange()
resets the cohort start and end date based on the
specified date range.
trimToDateRange(
cohort,
dateRange,
cohortId = NULL,
startDate = "cohort_start_date",
endDate = "cohort_end_date",
name = tableName(cohort)
)
cohort |
A cohort table in a cdm reference. |
dateRange |
A window of time during which the index date must have been observed. |
cohortId |
IDs of the cohorts to modify. 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 with the restriction. |
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.
library(CohortConstructor)
cdm <- mockCohortConstructor()
cdm$cohort1 |>
trimToDateRange(startDate = "cohort_start_date",
endDate = "cohort_end_date",
dateRange = as.Date(c("2015-01-01",
"2015-12-31")))