date_source {admiral}

R Documentation

Create a date_source object

Description

Create a date_source object as input for derive_var_extreme_dt() and derive_var_extreme_dtm().

Usage

date_source(
  dataset_name,
  filter = NULL,
  date,
  traceability_vars = NULL,
  set_values_to = NULL
)

Arguments

dataset_name	The name of the dataset, i.e. a string, used to search for the date.
filter	An unquoted condition for filtering dataset.
date	A variable or an expression providing a date. A date or a datetime can be specified. An unquoted symbol or expression is expected.
traceability_vars	A named list returned by exprs() defining the traceability variables, e.g. exprs(LALVDOM = "AE", LALVSEQ = AESEQ, LALVVAR = "AESTDTC"). The values must be a symbol, a character string, a numeric, an expression, or NA. Please use set_values_to instead.
set_values_to	Variables to be set

Value

An object of class date_source.

See Also

derive_var_extreme_dtm(), derive_var_extreme_dt()

Source Objects: basket_select(), censor_source(), death_event, dthcaus_source(), event_joined(), event_source(), event(), query(), records_source(), tte_source()

Examples

# treatment end date from ADSL
trt_end_date <- date_source(
  dataset_name = "adsl",
  date = TRTEDT
)

# lab date from LB where assessment was taken, i.e. not "NOT DONE"
lb_date <- date_source(
  dataset_name = "lb",
  filter = LBSTAT != "NOT DONE" | is.na(LBSTAT),
  date = convert_dtc_to_dt(LBDTC)
)

# death date from ADSL including traceability variables
death_date <- date_source(
  dataset_name = "adsl",
  date = DTHDT,
  set_values_to = exprs(
    LALVDOM = "ADSL",
    LALVVAR = "DTHDT"
  )
)

---