event_joined: Create a 'event_joined' Object

In admiral: ADaM in R Asset Library

Create a event_joined Object

Description

The event_joined object is used to define events as input for the derive_extreme_event() function. This object should be used if the event does not depend on a single observation of the source dataset but on multiple observations. For example, if the event needs to be confirmed by a second observation of the source dataset.

The events are selected by calling filter_joined(). See its documentation for more details.

Usage

event_joined(
  dataset_name = NULL,
  condition,
  order = NULL,
  join_vars,
  join_type,
  first_cond = NULL,
  set_values_to = NULL,
  keep_source_vars = NULL,
  description = NULL
)

Arguments

dataset_name	Dataset name of the dataset to be used as input for the event. The name refers to the dataset specified for source_datasets in derive_extreme_event(). If the argument is not specified, the input dataset (dataset) of derive_extreme_event() is used.
condition	An unquoted condition for selecting the observations, which will contribute to the extreme event. Permitted Values: an unquoted condition
order	If specified, the specified variables or expressions are used to select the first observation. Permitted Values: list of expressions created by exprs(), e.g., exprs(ADT, desc(AVAL)) or NULL
join_vars	Variables to keep from joined dataset The variables needed from the other observations should be specified for this parameter. The specified variables are added to the joined dataset with suffix ".join". For example to select all observations with AVALC == "Y" and AVALC == "Y" for at least one subsequent visit join_vars = exprs(AVALC, AVISITN) and filter = AVALC == "Y" & AVALC.join == "Y" & AVISITN < AVISITN.join could be specified. The ⁠*.join⁠ variables are not included in the output dataset.
join_type	Observations to keep after joining The argument determines which of the joined observations are kept with respect to the original observation. For example, if join_type = "after" is specified all observations after the original observations are kept. Permitted Values: "before", "after", "all"
first_cond	Condition for selecting range of data If this argument is specified, the other observations are restricted up to the first observation where the specified condition is fulfilled. If the condition is not fulfilled for any of the subsequent observations, all observations are removed.
set_values_to	A named list returned by exprs() defining the variables to be set for the event, e.g. exprs(PARAMCD = "WSP", PARAM = "Worst Sleeping Problems"). The values can be a symbol, a character string, a numeric value, NA or an expression.
keep_source_vars	Variables to keep from the source dataset The specified variables are kept for the selected observations. The variables specified for by_vars (of derive_extreme_event()) and created by set_values_to are always kept. Permitted Values: A list of expressions where each element is a symbol or a tidyselect expression, e.g., exprs(VISIT, VISITNUM, starts_with("RS")).
description	Description of the event The description does not affect the derivations where the event is used. It is intended for documentation only.

Value

An object of class event_joined

See Also

derive_extreme_event(), event()

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

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