num_breaks: Number of cut-points for binning

View source: R/param_num_breaks.R

num_breaksR Documentation

Number of cut-points for binning

Description

This parameter controls how many bins are used when discretizing predictors. Used in recipes::step_discretize() and embed::step_discretize_xgb().

Usage

num_breaks(range = c(2L, 10L), 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.

Examples

num_breaks()

dials documentation built on Sept. 11, 2024, 8:25 p.m.