Skip to contents

Set cohort end date to the first of a set of column dates

Source: R/exitAtColumnDate.R
exitAtFirstDate.Rd

exitAtFirstDate() resets cohort end date based on a set of specified column dates. The first date that occurs is chosen.

Usage

exitAtFirstDate(
  cohort,
  dateColumns,
  cohortId = NULL,
  returnReason = FALSE,
  keepDateColumns = TRUE,
  name = tableName(cohort),
  .softValidation = FALSE
)

Arguments

cohort

A cohort table in a cdm reference.

dateColumns

Character vector indicating date columns in the cohort table to consider.

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.

returnReason

If TRUE it will return a column indicating which of the dateColumns was used.

keepDateColumns

If TRUE the returned cohort will keep columns in dateColumns.

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

Value

The cohort table.

Examples

# \donttest{
library(CohortConstructor)
library(PatientProfiles)

cdm <- mockCohortConstructor()

cdm$cohort1 <- cdm$cohort1 |>
  addTableIntersectDate(tableName = "observation", nameStyle = "next_obs", order = "first") |>
  addFutureObservation(futureObservationType = "date", name = "cohort1")

cdm$cohort1 |>
  exitAtFirstDate(dateColumns = c("next_obs", "future_observation"))
#> Joining with `by = join_by(cohort_definition_id, subject_id,
#> cohort_start_date)`
#> # A tibble: 57 × 6
#>    cohort_definition_id subject_id cohort_start_date cohort_end_date next_obs  
#>                   <int>      <int> <date>            <date>          <date>    
#>  1                    1          1 2018-05-14        2018-05-27      2018-05-27
#>  2                    1          2 1966-05-06        1966-05-13      1966-05-13
#>  3                    1          3 1986-11-18        1987-06-27      1987-06-27
#>  4                    1          6 2011-02-19        2011-03-23      2011-03-23
#>  5                    1         11 2015-11-07        2015-12-07      2015-12-07
#>  6                    1         12 2015-05-09        2015-09-12      2015-09-12
#>  7                    1         13 2008-11-21        2008-11-28      2008-11-28
#>  8                    1         14 1991-08-19        1991-09-02      1991-09-02
#>  9                    1         16 2012-03-04        2012-03-05      2012-03-05
#> 10                    1         18 2016-06-08        2016-06-14      2016-06-14
#> # ℹ 47 more rows
#> # ℹ 1 more variable: future_observation <date>
# }