ParamHelpers (version 1.3)

Param: Create a description object for a parameter.

Description

For each parameter type a special constructor function is available, see below.

Usage

makeNumericParam(id, lower = -Inf, upper = Inf, default, trafo = NULL,
  requires = NULL)
makeNumericVectorParam(id, len, lower = -Inf, upper = Inf, cnames = NULL,
  default, trafo = NULL, requires = NULL)
makeIntegerParam(id, lower = -Inf, upper = Inf, default, trafo = NULL,
  requires = NULL)
makeIntegerVectorParam(id, len, lower = -Inf, upper = Inf, cnames = NULL,
  default, trafo = NULL, requires = NULL)
makeLogicalParam(id, default, requires = NULL)
makeLogicalVectorParam(id, len, cnames = NULL, default, requires = NULL)
makeDiscreteParam(id, values, trafo = NULL, default, requires = NULL)
makeDiscreteVectorParam(id, len, values, default, requires = NULL)
makeFunctionParam(id, default = default, requires = NULL)
makeUntypedParam(id, default, requires = NULL)

Arguments

id

[character(1)] Name of parameter.

len

[integer(1)] Length of vector parameter.

lower

[numeric] Lower bounds. A singe value of length 1 is automatically replicated to len for vector parameters. Default is -Inf.

upper

[numeric] Upper bounds. A singe value of length 1 is automatically replicated to len for vector parameters. Default is Inf.

values

[vector | list] Possible discrete values. Instead of using a vector of atomic values, you are also allowed to pass a list of quite complex R objects, which are used as discrete choices. If you do the latter, the

cnames

[character] Component names for vector params (except discrete). Every function in this package that creates vector values for such a param, will name that vector with cnames.

default

[any] Default value used in learner. If this argument is missing, it means no default value is available.

trafo

[NULL | function(x)] Function to transform parameter. It should be applied to the parameter value before it is, e.g., passed to a corresponding objective function. Function must accept a parameter value as the first argument and

requires

[NULL | R expression] States requirements on other paramaters' values, so that setting this parameter only makes sense if its requirements are satisfied (dependent parameter). Only really useful if the parameter is included in a

Value

• [Param].

Details

The S3 class is a list which stores these elements: [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

Examples

makeNumericParam("x",lower = -1, upper = 1)
makeNumericVectorParam("x", len = 2)
makeDiscreteParam("y", values = c("a","b"))