| step_textfeature | R Documentation |
step_textfeature() creates a specification of a recipe step that will
extract a number of numeric features of a text column.
step_textfeature(
recipe,
...,
role = "predictor",
trained = FALSE,
columns = NULL,
extract_functions = count_functions,
prefix = "textfeature",
keep_original_cols = FALSE,
skip = FALSE,
id = rand_id("textfeature")
)
recipe |
A |
... |
One or more selector functions to choose which variables are
affected by the step. See |
role |
For model terms created by this step, what analysis role should they be assigned? By default, the new columns created by this step from the original variables will be used as predictors in a model. |
trained |
A logical to indicate if the quantities for preprocessing have been estimated. |
columns |
A character vector of the selected variable names. This is
|
extract_functions |
A named list of feature extracting functions. Each
function should take a character vector and return a numeric vector of the
same length. Defaults to |
prefix |
A character string that will be the prefix to the resulting new variables. See notes below. |
keep_original_cols |
A logical to keep the original variables in the
output. 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. |
This step will take a character column and returns a number of numeric
columns equal to the number of functions in the list passed to the
extract_functions argument.
All the functions passed to extract_functions must take a character vector
as input and return a numeric vector of the same length, otherwise an error
will be thrown.
The new columns will have names that begin with prefix, then the name of
the variable, then the name of the function in extract_functions, all
separated by _. For example, with the default prefix = "textfeature", a
variable named text, and the default count_functions, the columns will
include textfeature_text_n_words and textfeature_text_n_uq_words.
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, functions, and id:
character, the selectors or variables selected
character, name of feature functions
character, id of this step
The underlying operation does not allow for case weights.
Other Steps for Numeric Variables From Characters:
step_dummy_hash(),
step_sentence_embeddings(),
step_sequence_onehot()
library(recipes)
library(modeldata)
data(tate_text)
tate_rec <- recipe(~., data = tate_text) |>
step_textfeature(medium)
tate_obj <- tate_rec |>
prep()
bake(tate_obj, new_data = NULL) |>
slice(1:2)
bake(tate_obj, new_data = NULL) |>
pull(textfeature_medium_n_words)
tidy(tate_rec, number = 1)
tidy(tate_obj, number = 1)
# Using custom extraction functions
nchar_round_10 <- function(x) round(nchar(x) / 10) * 10
recipe(~., data = tate_text) |>
step_textfeature(medium,
extract_functions = list(nchar10 = nchar_round_10)
) |>
prep() |>
bake(new_data = NULL)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.