safetyGraphics (version 1.1.0)

setSettingsValue: Set the value for a given named parameter

Description

Sets the value for a named parameter (key) to given value in a list (settings)

Usage

setSettingsValue(key, value, settings, forceCreate = FALSE)

Arguments

key

a list (like those provided by getSettingKeys()) defining the position of parameter in the settings object.

value

the value to set

settings

The settings list used to generate a chart like eDISH()

forceCreate

Specifies whether the function should create a new list() when none exisits. This most commonly occurs when deeply nested objects.

Value

the updated settings object

Examples

# NOT RUN {
testSet<-list(a=list(b="myValue"))
safetyGraphics:::setSettingsValue(key=list("a","b"), value="notMyValue", settings=testSet) 
#returns list(a=list(b="notMyValue")))

adamSettings<-generateSettings(standard="AdAM")
safetyGraphics:::setSettingsValue(list("id_col"),"customID",adamSettings) 
safetyGraphics:::setSettingsValue(list("measure_values","ALP"),"Alanine Aminotrans",adamSettings)
safetyGraphics:::setSettingsValue(list("myCustomSetting"),"customized",adamSettings) 
#adds myCustomSetting to adamSettings

# }