Package 'ordered'

Dials for ordinal engine parameters

Description

The threshold_structure dial is auxiliary to ordinal regression models that use the "clm" engine. It corresponds to the threshold tuning parameter that would be specified using set_engine("clm", ...).

Usage

threshold_structure(
  values = c("flexible", "symmetric", "symmetric2", "equidistant")
)

values_ordinal_link_clm

Arguments

values

A character string of possible values.

Details

The vector values_ordinal_link_clm extends the default ordinal_link options encoded in dials::values_ordinal_link to those accepted by ordinal::clm().

threshold_structure() is a dial for the threshold structure in cumulative link models. See ?ordinal::clm for more details. Use set_args(threshold = ...) to set this parameter on a model spec. These parameters are engine-specific, not general to ordinal regression models, so are provided here rather than in dials.

Value

An object of S3 parent class param and primary class qual_param; see dials::new_qual_param().

Examples

values_ordinal_link_clm
dials::ordinal_link(values = values_ordinal_link_clm)
threshold_structure()

---

Dials for ordinalForest engine parameters

Description

These parameters are auxiliary to random forest models that use the "ordinalForest" engine. They correspond to tuning parameters that would be specified using set_engine("ordinalForest", ...).

Usage

naive_scores(values = c(FALSE, TRUE))

num_scores(range = c(100L, 2000L), trans = NULL)

num_score_perms(range = c(100L, 500L), trans = NULL)

num_score_trees(range = c(10L, 200L), trans = NULL)

num_scores_best(range = c(2L, 20L), trans = NULL)

ord_metric(values = values_ord_metric)

values_ord_metric

Arguments

values	A character string of possible values.
range	A two-element vector holding the defaults for the smallest and largest possible values, respectively. If a transformation is specified, these values should be in the transformed units.
trans	A trans object from the scales package, such as scales::transform_log10() or scales::transform_reciprocal(). If not provided, the default is used which matches the units used in range. If no transformation, NULL.

Details

The vector values_ord_metric provides options to the ord_metric dial.

These functions generate parameters for parsnip::rand_forest() models using the "ordinalForest" engine. See ?ordinalForest::ordfor() for more details on the original parameters. These parameters are engine-specific, not general to decision tree models, so are provided here rather than in dials.

• naive_scores(): Whether to construct only a "naive" ordinal forest using the scores $1,2,3,\ldots$ for the ordinal values; tunes naive.

• num_scores(): The number of score sets tried prior to optimization; tunes nsets.

• num_score_perms(): The number of permutations of the class width ordering to try for each score set tried (after the first); tunes npermtrial.

• num_score_trees(): The number of trees in the score set–specific forests; tunes ntreeperdiv.

• num_scores_best(): The number of top-performing score sets used to calculate the optimized score set; tunes nbest.

• ord_metric(): The performance function used to evaluate score set–specific forests; tunes perffunction. See also ?ordinalForest::perff.

Value

An object of S3 parent class param and primary class qual_param or quant_param; see dials::new_qual_param() and [dials::new_quant_param().

See Also

dials::trees()

Examples

naive_scores()
num_scores()
num_score_perms()
num_score_trees()
num_scores_best()
values_ord_metric
ord_metric()

---

Dials for orf engine parameters

Description

These parameters are auxiliary to random forest models that use the "orf" engine. They correspond to tuning parameters that would be specified using set_engine("orf", ...).

Usage

sample_fraction(range = c(0.1, 1), trans = NULL)

honesty(values = c(TRUE, FALSE))

honesty_fraction(range = c(0.1, 0.9), trans = NULL)

Arguments

range	A two-element vector holding the defaults for the smallest and largest possible values, respectively. If a transformation is specified, these values should be in the transformed units.
trans	A trans object from the scales package, such as scales::transform_log10() or scales::transform_reciprocal(). If not provided, the default is used which matches the units used in range. If no transformation, NULL.
values	A logical vector of possible values. See values_ord_metric.

Details

These functions generate parameters for parsnip::rand_forest() models using the "orf" engine. See ?orf::orf() for more details on the original parameters. These parameters are engine-specific, not general to random forest models, so are provided here rather than in dials.

• sample_fraction(): The fraction of observations to be subsampled; tunes sample.fraction.

• honesty(): Whether to use honest splitting (sample splitting); tunes honesty.

• honesty_fraction(): The fraction of observations reserved for the honest (estimation) sample; tunes honesty.fraction.

Value

An object of S3 parent class param and primary class qual_param or quant_param; see dials::new_qual_param() and dials::new_quant_param().

See Also

dials::trees()

Examples

sample_fraction()
honesty()
honesty_fraction()

---

Dials for rpartScore engine parameters

Description

These parameters are auxiliary to decision tree models that use the "rpartScore" engine. They correspond to tuning parameters that would be specified using set_engine("rpartScore", ...).

Usage

split_func(values = c("abs", "quad"))

prune_func(values = c("mr", "mc"))

Arguments

values

A character string of possible values.

Details

split_func and prune_func are dials for split and prune, respectively. See ?rpartScore::rpartScore for more details on the original parameters. These parameters are engine-specific, not general to decision tree models, so are provided here rather than in dials.

Value

An object of S3 parent class param and primary class qual_param; see dials::new_qual_param().

See Also

dials::trees()

Examples

split_func()
prune_func()

---