Cut a numeric variable into a factor
step_cut() creates a specification of a recipe step that cuts a numeric
variable into a factor based on provided boundary values
step_cut(
recipe,
...,
role = NA,
trained = FALSE,
breaks,
include_outside_range = FALSE,
skip = FALSE,
id = rand_id("cut")
)
## S3 method for class 'step_cut'
tidy(x, ...)recipe |
A recipe object. The step will be added to the sequence of operations for this recipe. |
... |
One or more selector functions to choose which variables are
affected by the step. See |
role |
Not used by this step since no new variables are created. |
trained |
A logical to indicate if the quantities for preprocessing have been estimated. |
breaks |
A numeric vector with at least one cut point. |
include_outside_range |
Logical, indicating if values outside the
range in the train set should be included in the lowest or highest bucket.
Defaults to |
skip |
A logical. Should the step be skipped when the recipe is baked
by |
id |
A character string that is unique to this step to identify it. |
x |
A |
Unlike the base::cut() function there is no need to specify the
min and the max values in the breaks. All values before the lowest break
point will end up in the first bucket, all values after the last break
points will end up in the last.
step_cut() will call base::cut() in the baking step with
include.lowest set to TRUE.
An updated version of recipe with the new step added to the
sequence of existing steps (if any).
df <- data.frame(x = 1:10, y = 5:14) rec <- recipe(df) # The min and max of the variable are used as boundaries # if they exceed the breaks rec %>% step_cut(x, breaks = 5) %>% prep() %>% bake(df) # You can use the same breaks on multiple variables # then for each variable the boundaries are set separately rec %>% step_cut(x, y, breaks = c(6, 9)) %>% prep() %>% bake(df) # You can keep the original variables using `step_mutate` or # `step_mutate_at`, for transforming multiple variables at once rec %>% step_mutate(x_orig = x) %>% step_cut(x, breaks = 5) %>% prep() %>% bake(df) # It is up to you if you want values outside the # range learned at prep to be included new_df <- data.frame(x = 1:11) rec %>% step_cut(x, breaks = 5, include_outside_range = TRUE) %>% prep() %>% bake(new_df) rec %>% step_cut(x, breaks = 5, include_outside_range = FALSE) %>% prep() %>% bake(new_df)
Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.