newparam {dials}  R Documentation 
Tools for creating new parameter objects
Description
These functions are used to construct new parameter objects. Generally,
these functions are called from higher level parameter generating functions
like mtry()
.
Usage
new_quant_param(
type = c("double", "integer"),
range = NULL,
inclusive = NULL,
default = deprecated(),
trans = NULL,
values = NULL,
label = NULL,
finalize = NULL,
...,
call = caller_env()
)
new_qual_param(
type = c("character", "logical"),
values,
default = deprecated(),
label = NULL,
finalize = NULL,
...,
call = caller_env()
)
Arguments
type 
A single character value. For quantitative parameters, valid
choices are 
range 
A twoelement vector with the smallest or largest possible
values, respectively. If these cannot be set when the parameter is defined,
the 
inclusive 
A twoelement logical vector for whether the range
values should be inclusive or exclusive. If 
default 
No longer used. If a value is supplied, it will be ignored and a warning will be thrown. 
trans 
A 
values 
A vector of possible values that is required when 
label 
An optional named character string that can be used for
printing and plotting. The name should match the object name (e.g.

finalize 
A function that can be used to set the dataspecific
values of a parameter (such as the 
... 
These dots are for future extensions and must be empty. 
call 
The call passed on to 
Value
An object of class "param"
with the primary class being either
"quant_param"
or "qual_param"
. The range
element of the object
is always converted to a list with elements "lower"
and "upper"
.
Examples
# Create a function that generates a quantitative parameter
# corresponding to the number of subgroups.
num_subgroups < function(range = c(1L, 20L), trans = NULL) {
new_quant_param(
type = "integer",
range = range,
inclusive = c(TRUE, TRUE),
trans = trans,
label = c(num_subgroups = "# Subgroups"),
finalize = NULL
)
}
num_subgroups()
num_subgroups(range = c(3L, 5L))
# Custom parameters instantly have access
# to sequence generating functions
value_seq(num_subgroups(), 5)