R: Add an Extreme Event Parameter

derive_param_extreme_event {admiral}

R Documentation

Add an Extreme Event Parameter

Description

This function is deprecated, please use derive_extreme_records() instead.

Add a new parameter for the first or last event occurring in a dataset. The variable given in new_var indicates if an event occurred or not. For example, the function can derive a parameter for the first disease progression.

Usage

derive_param_extreme_event(
  dataset = NULL,
  dataset_adsl,
  dataset_source,
  filter_source,
  order = NULL,
  new_var = NULL,
  true_value = "Y",
  false_value = "N",
  mode = "first",
  subject_keys = get_admiral_option("subject_keys"),
  set_values_to,
  check_type = "warning"
)

Arguments

`dataset`	Input dataset The `PARAMCD` variable is expected.
`dataset_adsl`	ADSL input dataset The variables specified for `subject_keys` are expected. For each observation of the specified dataset a new observation is added to the input dataset.
`dataset_source`	Source dataset All observations in the specified dataset fulfilling the condition specified by `filter_source` are considered as an event. The variables specified by the `subject_keys` and `order` argument (if applicable) are expected.
`filter_source`	Source filter All observations in `dataset_source` fulfilling the specified condition are considered as an event. For subjects with at least one event `new_var` is set to `true_value`. For all other subjects `new_var` is set to `false_value`.
`order`	Order variable List of symbols for sorting the source dataset (`dataset_source`). Permitted Values: list of expressions created by `exprs()`, e.g., `exprs(ADT, desc(AVAL))`.
`new_var`	New variable The name of the variable which will indicate whether an event happened or not.
`true_value`	True value For all subjects with at least one observation in the source dataset (`dataset_source`) fulfilling the event condition (`filter_source`), `new_var` is set to the specified value `true_value`.
`false_value`	False value For all other subjects in `dataset_adsl` without an event, `new_var` is set to the specified value `false_value`.
`mode`	Selection mode (first or last) If `"first"` is specified, the first observation of each subject is selected. If `"last"` is specified, the last observation of each subject is selected. Permitted Values: `"first"`, `"last"`
`subject_keys`	Variables to uniquely identify a subject A list of symbols created using `exprs()` is expected.
`set_values_to`	Variables to set A named list returned by `exprs()` defining the variables to be set for the new parameter, e.g. `exprs(PARAMCD = "PD", PARAM = "Disease Progression")` is expected. The values must be symbols, character strings, numeric values, `NA`, or an expression. Note, if you require a date or datetime variable to be populated, this needs to be defined here.
`check_type`	Check uniqueness? If `"warning"` or `"error"` is specified, a message is issued if the observations of the source dataset (`dataset_source`) restricted by `filter_source` are not unique with respect to the subject keys (`subject_key` argument) and `order`. Permitted Values: `"none"`, `"warning"`, `"error"`

Details

The source dataset (dataset_source) is restricted to observations fulfilling filter_source.
For each subject (with respect to the variables specified for the subject_keys argument) either the first or last observation from the restricted source dataset is selected. This is depending on mode, (with respect to order, if applicable) where the event condition (filter_source argument) is fulfilled.
For each observation in dataset_adsl a new observation is created. For subjects with event new_var is set to true_value. For all other subjects new_var is set to false_value. For subjects with event all variables from dataset_source are kept. For subjects without event all variables which are in both dataset_adsl and dataset_source are kept.
The variables specified by the set_values_to argument are added to the new observations.
The new observations are added to input dataset.

Value