Restrict cohort on future observation

requireFutureObservation() filters cohort records, keeping only records where individuals satisfy the specified future observation criteria.

Usage

requireFutureObservation(
  cohort,
  minFutureObservation,
  cohortId = NULL,
  indexDate = "cohort_start_date",
  name = tableName(cohort)
)

Arguments

cohort

A cohort table in a cdm reference.

minFutureObservation

A minimum number of continuous future observation days in the database.

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

Variable in cohort that contains the date to compute the demographics characteristics on which to restrict on.

name

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

Value

The cohort table with only records for individuals satisfying the future observation requirement

Examples

# \donttest{
library(CohortConstructor)
cdm <- mockCohortConstructor()
cdm$cohort1 |>
  requireFutureObservation(indexDate = "cohort_start_date",
                           minFutureObservation = 30)
#> # Source:   table<main.cohort1> [10 x 4]
#> # Database: DuckDB v1.0.0 [unknown@Linux 6.5.0-1025-azure:R 4.4.1/:memory:]
#>    cohort_definition_id subject_id cohort_start_date cohort_end_date
#>                   <int>      <int> <date>            <date>         
#>  1                    1          1 2001-05-30        2003-05-01     
#>  2                    1          1 2003-05-02        2006-06-10     
#>  3                    1          2 2000-05-04        2000-05-17     
#>  4                    1          2 2000-05-18        2001-01-23     
#>  5                    1          3 2015-01-27        2015-06-28     
#>  6                    1          4 1996-06-30        1998-11-20     
#>  7                    1          5 2012-03-20        2012-04-30     
#>  8                    1          5 2012-05-01        2012-07-24     
#>  9                    1          7 2014-03-07        2014-03-07     
#> 10                    1          7 2014-03-08        2014-03-20     
# }