ParamHelpers (version 1.1-36)

paramValueToString: Convert a value to a string.

Description

Useful helper for logging. For discrete parameter values always the name of the discrete value is used.

Usage

paramValueToString(par, x, show.missing.values = FALSE)

Arguments

par

[Param | ParamSet] Parameter or parameter set.

x

[any] Value for parameter or value for parameter set. In the latter case it must be named list.

show.missing.values

[logical(1)] Display NA for parameters, which have no setting, because their requirements are not satified (dependent parameters), instead of nothing? Default is FALSE.

Value

• [character(1)].

Examples

p <- makeNumericParam("x")
paramValueToString(p, 1) # "1.00"
paramValueToString(p, 1.2345) # "1.23"

p <- makeIntegerVectorParam("x", len=2)
paramValueToString(p, c(1L, 2L)) # 1,2

p <- makeLogicalParam("x")
paramValueToString(p, TRUE) # "TRUE"

p <- makeDiscreteParam("x", values=list(a=NULL, b=2))
paramValueToString(p, NULL) # "a"