derive_var_merged_character: Merge a Character Variable

In admiral: ADaM in R Asset Library

Merge a Character Variable

Description

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

Merge a character variable from a dataset to the input dataset. The observations to merge can be selected by a condition and/or selecting the first or last observation for each by group.

Usage

derive_var_merged_character(
  dataset,
  dataset_add,
  by_vars,
  order = NULL,
  new_var,
  source_var,
  case = NULL,
  filter_add = NULL,
  mode = NULL,
  missing_value = NA_character_
)

Arguments

dataset	Input dataset The variables specified by the by_vars argument are expected.
dataset_add	Additional dataset The variables specified by the by_vars, the source_var, and the order argument are expected.
by_vars	Grouping variables The input dataset and the selected observations from the additional dataset are merged by the specified by variables. The by variables must be a unique key of the selected observations. Variables from the additional dataset can be renamed by naming the element, i.e., ⁠by_vars = exprs(<name in input dataset> = <name in additional dataset>)⁠, similar to the dplyr joins. Permitted Values: list of variables created by exprs()
order	Sort order If the argument is set to a non-null value, for each by group the first or last observation from the additional dataset is selected with respect to the specified order. Variables defined by the new_vars argument can be used in the sort order. Permitted Values: list of expressions created by exprs(), e.g., exprs(ADT, desc(AVAL)) or NULL
new_var	New variable The specified variable is added to the additional dataset and set to the transformed value with respect to the case argument.
source_var	Source variable
case	Change case Changes the case of the values of the new variable. Default: NULL Permitted Values: NULL, "lower", "upper", "title"
filter_add	Filter for additional dataset (dataset_add) Only observations fulfilling the specified condition are taken into account for merging. If the argument is not specified, all observations are considered. Variables defined by the new_vars argument can be used in the filter condition. Permitted Values: a condition
mode	Selection mode Determines if the first or last observation is selected. If the order argument is specified, mode must be non-null. If the order argument is not specified, the mode argument is ignored. Permitted Values: "first", "last", NULL
missing_value	Values used for missing information The new variable is set to the specified value for all by groups without observations in the additional dataset. Default: NA_character_ Permitted Value: A character scalar

Details

1. The additional dataset is restricted to the observations matching the filter_add condition.

2. The (transformed) character variable is added to the additional dataset.

3. If order is specified, for each by group the first or last observation (depending on mode) is selected.

4. The character variable is merged to the input dataset.

Value

The output dataset contains all observations and variables of the input dataset and additionally the variable specified for new_var derived from the additional dataset (dataset_add).

See Also

Other deprecated: derive_param_extreme_event(), derive_var_basetype(), derive_var_confirmation_flag(), derive_var_last_dose_amt(), derive_var_last_dose_date(), derive_var_last_dose_grp(), derive_var_merged_cat(), derive_vars_last_dose()

admiral documentation built on Oct. 19, 2023, 1:08 a.m.