safetyGraphics (version 1.1.0)

generateSettings: Generate a settings object based on a data standard

Description

This function returns a settings object for the eDish chart based on the specified data standard.

Usage

generateSettings(standard = "None", charts = NULL,
  useDefaults = TRUE, partial = FALSE, partial_keys = NULL,
  custom_settings = NULL)

Arguments

standard

The data standard for which to create settings. Valid options are "sdtm", "adam" or "none". Default: "None".

charts

The chart or charts for which settings should be generated. Default: NULL (uses all available charts).

useDefaults

Specifies whether default values from settingsMetadata should be included in the settings object. Default: TRUE.

partial

Boolean for whether or not the standard is a partial standard. Default: FALSE.

partial_keys

Optional character vector of the matched settings if partial is TRUE. Settings should be identified using the text_key format described in ?settingsMetadata. Setting is ignored when partial is FALSE. Default: NULL.

custom_settings

A tibble describing custom settings to be added to the settings object. Custom values overwrite default values when provided. Tibble should have text_key and customValue columns. Default: NULL.

Value

A list containing the appropriate settings for the selected chart

Details

The function is designed to work with the SDTM and ADaM CDISC(<https://www.cdisc.org/>) standards for clinical trial data. Currently, eDish is the only chart supported.

Examples

# NOT RUN {
generateSettings(standard="SDTM")
generateSettings(standard="SdTm") #also ok
generateSettings(standard="ADaM")
pkeys<- c("id_col","measure_col","value_col")
generateSettings(standard="adam", partial=TRUE, partial_keys=pkeys)

generateSettings(standard="a different standard")
#returns shell settings list with no data mapping

# }