paradox (version 0.1.0)

ParamFct: Factor Parameter

Description

A Param to describe categorical (factor) parameters.

Arguments

Format

R6::R6Class object inheriting from Param.

Construction

ParamFct$new(id, levels, special_vals = list(), default = NO_DEF, tags = character())

Arguments of Param, and additionally:

  • levels :: character() Set of allowed levels.

Fields

Fields of Param, and additionally:

  • lower :: numeric(1) Lower bound. Always NA for this parameter.

  • upper :: numeric(1) Upper bound. Always NA for this parameter.

  • levels :: character() Allowed levels.

  • nlevels :: Inf Number of categorical levels.

  • is_bounded :: TRUE Are the bounds finite? Always TRUE for this parameter.

Methods

See Param.

See Also

Other Params: ParamDbl, ParamInt, ParamLgl, ParamUty, Param

Examples

Run this code
# NOT RUN {
ParamFct$new("f", levels = letters[1:3])
# }

Run the code above in your browser using DataLab