dthcaus_source: Create a 'dthcaus_source' Object

Description Usage Arguments Value Author(s) See Also

View source: R/derive_var_dthcaus.R

Description

Create a dthcaus_source Object

Usage

1
2
3
4
5
6
7
8
9
dthcaus_source(
  dataset_name,
  filter,
  date,
  mode = "first",
  dthcaus,
  traceability_vars = NULL,
  dataset = deprecated()
)

Arguments

dataset_name

The name of the dataset, i.e. a string, used to search for the death cause.

filter

An expression used for filtering dataset.

date

A character vector to be used for sorting dataset.

mode

One of "first" or "last". Either the "first" or "last" observation is preserved from the dataset which is ordered by date.

dthcaus

A variable name or a string literal — if a variable name, e.g., AEDECOD, it is the variable in the source dataset to be used to assign values to DTHCAUS; if a string literal, e.g. "Adverse Event", it is the fixed value to be assigned to DTHCAUS.

traceability_vars

A named list returned by vars() listing the traceability variables, e.g. vars(DTHDOM = "DS", DTHSEQ = DSSEQ). The left-hand side (names of the list elements) gives the names of the traceability variables in the returned dataset. The right-hand side (values of the list elements) gives the values of the traceability variables in the returned dataset. These can be either strings or symbols referring to existing variables.

dataset

Deprecated, please use dataset_name instead.

Value

An object of class "dthcaus_source".

Author(s)

Shimeng Huang

See Also

derive_var_dthcaus()


epijim/admiral documentation built on Feb. 13, 2022, 12:15 a.m.