Skip to contents

Derive Death Cause

Source: R/derive_var_dthcaus.R
derive_var_dthcaus.Rd

[Deprecated] The derive_var_dthcaus() function has been deprecated in favor of derive_vars_extreme_event().

Derive death cause (DTHCAUS) and add traceability variables if required.

Usage 

derive_var_dthcaus(
  dataset,
  ...,
  source_datasets,
  subject_keys = get_admiral_option("subject_keys")
)

Arguments

dataset

Input dataset

The variables specified by the subject_keys argument are expected to be in the dataset.

Default value

none

...

Objects of class "dthcaus_source" created by dthcaus_source().

Default value

none

source_datasets

A named list containing datasets in which to search for the death cause

Default value

none

subject_keys

Variables to uniquely identify a subject

A list of expressions where the expressions are symbols as returned by exprs() is expected.

Default value

get_admiral_option("subject_keys")

Value

The input dataset with DTHCAUS variable added.

Details

This function derives DTHCAUS along with the user-defined traceability variables, if required. If a subject has death info from multiple sources, the one from the source with the earliest death date will be used. If dates are equivalent, the first source will be kept, so the user should provide the inputs in the preferred order.

See also

dthcaus_source()

Other deprecated: date_source(), derive_param_extreme_record(), derive_var_extreme_dt(), derive_var_extreme_dtm(), derive_var_merged_summary(), dthcaus_source(), get_summary_records()