sampleValues {ParamHelpers}R Documentation

Sample n random values from a parameter or a parameter set uniformly.

Description

Sample n random values from a parameter or a parameter set uniformly.

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

Usage

sampleValues(par, n, discrete.names = FALSE, trafo = FALSE)

Arguments

par

[Param | ParamSet]
Parameter or parameter set.

n

[integer(1)]
Number of values.

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

[list]. For consistency always a list is returned.

Examples

p = makeIntegerParam("x", lower = -10, upper = 10)
sampleValues(p, 4)

p = makeNumericParam("x", lower = -10, upper = 10)
sampleValues(p, 4)

p = makeLogicalParam("x")
sampleValues(p, 4)

ps = makeParamSet(
  makeNumericParam("u", lower = 1, upper = 10),
  makeIntegerParam("v", lower = 1, upper = 10),
  makeDiscreteParam("w", values = 1:2)
)
sampleValues(ps, 2)
[Package ParamHelpers version 1.12 Index]