Learn R Programming

ParamHelpers (version 1.10)

sampleValue: Sample a random value from a parameter or a parameter set uniformly.

Description

Dependent parameters whose requirements are not satisfied are represented by a scalar NA in the output.

Usage

sampleValue(par, discrete.names = FALSE, trafo = FALSE)

Arguments

par

[Param | ParamSet] Parameter or parameter set.

discrete.names

[logical(1)] Should names be sampled for discrete paramaters or values instead? Default is code FALSE.

trafo

[logical(1)] Transform all parameters by using theirs respective transformation functions. Default is FALSE.

Value

The return type is determined by the type of the parameter. For a set a named list of such values in the correct order is returned.

Examples

Run this code
# NOT RUN {
# bounds are necessary here, can't sample with Inf bounds:
u = makeNumericParam("x", lower = 0, upper = 1)
# returns a random number between 0 and 1:
sampleValue(u)

p = makeDiscreteParam("x", values = c("a","b","c"))
# can be either "a", "b" or "c"
sampleValue(p)

p = makeIntegerVectorParam("x", len = 2, lower = 1, upper = 5)
# vector of two random integers between 1 and 5:
sampleValue(p)

ps = makeParamSet(
  makeNumericParam("x", lower = 1, upper = 10),
  makeIntegerParam("y", lower = 1, upper = 10),
  makeDiscreteParam("z", values = 1:2)
)
sampleValue(ps)
# }

Run the code above in your browser using DataLab