Require that an index date is within a date range
Source:R/requireDateRange.R
requireInDateRange.RdrequireInDateRange() filters cohort records, keeping only those for
which the index date is within the specified date range.
Usage
requireInDateRange(
cohort,
dateRange,
cohortId = NULL,
indexDate = "cohort_start_date",
atFirst = FALSE,
name = tableName(cohort)
)Arguments
- cohort
A cohort table in a cdm reference.
- dateRange
A date vector with the minimum and maximum dates between which the index 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.
- indexDate
Name of the column in the cohort that contains the date of interest.
- atFirst
If FALSE the requirement will be applied to all records, if TRUE, it will only be required for the first entry of each subject.
- name
Name of the new cohort table created in the cdm object.
Examples
# \donttest{
library(CohortConstructor)
cdm <- mockCohortConstructor(nPerson = 100)
cdm$cohort1 |>
requireInDateRange(indexDate = "cohort_start_date",
dateRange = as.Date(c("2010-01-01", "2019-01-01")))
#> # Source: table<cohort1> [?? x 4]
#> # Database: DuckDB 1.4.0 [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 7 2013-03-03 2014-09-18
#> 2 1 7 2014-09-19 2014-12-14
#> 3 1 7 2015-04-04 2018-01-18
#> 4 1 8 2013-12-19 2016-08-09
#> 5 1 14 2018-02-26 2018-03-03
#> 6 1 16 2016-10-31 2016-11-22
#> 7 1 21 2015-11-25 2016-07-31
#> 8 1 25 2012-10-25 2013-11-11
#> 9 1 25 2013-11-12 2014-03-03
#> 10 1 25 2014-03-04 2014-07-26
#> # ℹ more rows
# }