| step_clean_levels | R Documentation |
step_clean_levels() creates a specification of a recipe step that will
clean nominal data (character or factor) so the levels consist only of
letters, numbers, and the underscore.
step_clean_levels(
recipe,
...,
role = NA,
trained = FALSE,
clean = NULL,
skip = FALSE,
id = rand_id("clean_levels")
)
recipe |
A |
... |
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. |
clean |
A named character vector to clean and recode categorical
levels. This is |
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. |
The levels are cleaned with janitor::make_clean_names(), which is the
function responsible for the cleaning, and then reset with
dplyr::recode_factor(). When data to be processed contains novel levels
(i.e., not contained in the training set), they are converted to missing.
An updated version of recipe with the new step added
to the sequence of existing steps (if any).
When you tidy() this step, a tibble is returned with
columns terms, orginal, value, and id:
character, the selectors or variables selected
character, the original levels
character, the cleaned levels
character, id of this step
The underlying operation does not allow for case weights.
step_clean_names(), recipes::step_factor2string(),
recipes::step_string2factor(), recipes::step_regex(),
recipes::step_unknown(), recipes::step_novel(), recipes::step_other()
Other Steps for Text Cleaning:
step_clean_names()
library(recipes)
library(modeldata)
data(Smithsonian)
smith_tr <- Smithsonian[1:15, ]
smith_te <- Smithsonian[16:20, ]
rec <- recipe(~., data = smith_tr)
rec <- rec |>
step_clean_levels(name)
rec <- prep(rec, training = smith_tr)
cleaned <- bake(rec, smith_tr)
tidy(rec, number = 1)
# novel levels are replaced with missing
bake(rec, smith_te)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.