Factor Parameter

A Param to describe categorical (factor) parameters.

See also

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

Super class

paradox::Param -> ParamFct

Public fields

levels

(character() | NULL)
Set of allowed levels. Always NULL for ParamDbl, ParamInt and ParamUty. Always c(TRUE, FALSE) for ParamLgl.

Active bindings

lower

(numeric(1))
Lower bound. Always NA for ParamFct, ParamLgl and ParamUty.

upper

(numeric(1))
Upper bound. Always NA for ParamFct, ParamLgl and ParamUty.

nlevels

(integer(1) | Inf)
Number of categorical levels. Always Inf for ParamDbl and ParamUty. The number of integers in the range [lower, upper], or Inf if unbounded for ParamInt. Always 2 for ParamLgl.

is_bounded

(logical(1))
Are the bounds finite? Always TRUE for ParamFct and ParamLgl. Always FALSE for ParamUty.

storage_type

(character(1))
Data type when values of this parameter are stored in a data table or sampled. Always "numeric" for ParamDbl. Always "character" for ParamFct. Always "integer" for ParamInt. Always "logical" for ParamLgl. Always "list" for ParamUty.

Methods

Public methods

• ParamFct$new()

• ParamFct$clone()

Inherited methods

• paradox::Param$assert()
• paradox::Param$check()
• paradox::Param$convert()
• paradox::Param$format()
• paradox::Param$print()
• paradox::Param$qunif()
• paradox::Param$rep()
• paradox::Param$test()

---

Method new()

Creates a new instance of this R6 class.

Usage

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

Arguments

id

(character(1))
Identifier of the object.

levels

(character())
Set of allowed levels.

special_vals

(list())
Arbitrary special values this parameter is allowed to take, to make it feasible. This allows extending the domain of the parameter. Note that these values are only used in feasibility checks, neither in generating designs nor sampling.

default

(any)
Default value. Can be from the domain of the parameter or an element of special_vals. Has value NO_DEF if no default exists. NULL can be a valid default. The value has no effect on ParamSet$values or the behavior of ParamSet$check(), $test() or $assert(). The default is intended to be used for documentation purposes. `

tags

(character())
Arbitrary tags to group and subset parameters. Some tags serve a special purpose:

• "required" implies that the parameters has to be given when setting values in ParamSet.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ParamFct$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

ParamFct$new("f", levels = letters[1:3])
#>    id    class lower upper levels        default
#> 1:  f ParamFct    NA    NA  a,b,c <NoDefault[3]>