step_dummy creates a specification of a recipe
step that will convert nominal data (e.g. character or factors)
into one or more numeric binary model terms for the levels of
the original data.
step_dummy( recipe, ..., role = "predictor", trained = FALSE, one_hot = FALSE, preserve = FALSE, naming = dummy_names, levels = NULL, skip = FALSE, id = rand_id("dummy") ) # S3 method for step_dummy 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
factor variables will be used to create the dummy variables. See
|
| role | For model terms created by this step, what analysis role should they be assigned?. By default, the function assumes that the binary dummy variable columns created by the original variables will be used as predictors in a model. |
| trained | A logical to indicate if the quantities for preprocessing have been estimated. |
| one_hot | A logical. For C levels, should C dummy variables be created rather than C-1? |
| preserve | A single logical; should the selected column(s) be retained (in addition to the new dummy variables). |
| naming | A function that defines the naming convention for new dummy columns. See Details below. |
| levels | A list that contains the information needed to
create dummy variables for each variable contained in
|
| 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 |
An updated version of recipe with the new step
added to the sequence of existing steps (if any). For the
tidy method, a tibble with columns terms (the
selectors or original variables selected) and columns (the
list of corresponding binary columns).
step_dummy will create a set of binary dummy
variables from a factor variable. For example, if an unordered
factor column in the data set has levels of "red", "green",
"blue", the dummy variable bake will create two additional
columns of 0/1 data for two of those three values (and remove
the original column). For ordered factors, polynomial contrasts
are used to encode the numeric values.
By default, the excluded dummy variable (i.e. the reference cell) will correspond to the first level of the unordered factor being converted.
The function allows for non-standard naming of the resulting
variables. For an unordered factor named x, with levels "a"
and "b", the default naming convention would be to create a
new variable called x_b. Note that if the factor levels are
not valid variable names (e.g. "some text with spaces"), it will
be changed by base::make.names() to be valid (see the example
below). The naming format can be changed using the naming
argument and the function dummy_names() is the default. This
function will also change the names of ordinal dummy variables.
Instead of values such as ".L", ".Q", or "^4", ordinal
dummy variables are given simple integer suffixes such as
"_1", "_2", etc.
To change the type of contrast being used, change the global
contrast option via options.
When the factor being converted has a missing value, all of the corresponding dummy variables are also missing.
When data to be processed contains novel levels (i.e., not
contained in the training set), a missing value is assigned to
the results. See step_other() for an alternative.
If no columns are selected (perhaps due to an earlier step_zv()),
bake() will return the data as-is (e.g. with no dummy variables).
The package vignette for dummy variables and interactions has more information.
step_factor2string(), step_string2factor(),
dummy_names(), step_regex(), step_count(),
step_ordinalscore(), step_unorder(), step_other()
step_novel()
library(modeldata) data(okc) okc <- okc[complete.cases(okc),] rec <- recipe(~ diet + age + height, data = okc) dummies <- rec %>% step_dummy(diet) dummies <- prep(dummies, training = okc) dummy_data <- bake(dummies, new_data = okc) unique(okc$diet)#> [1] "strictly anything" "mostly other" "anything" #> [4] "vegetarian" "mostly anything" "mostly vegetarian" #> [7] "strictly vegan" "strictly vegetarian" "mostly vegan" #> [10] "strictly other" "mostly halal" "other" #> [13] "vegan" "mostly kosher" "strictly halal" #> [16] "halal" "strictly kosher" "kosher"#> [1] "diet_halal" "diet_kosher" #> [3] "diet_mostly.anything" "diet_mostly.halal" #> [5] "diet_mostly.kosher" "diet_mostly.other" #> [7] "diet_mostly.vegan" "diet_mostly.vegetarian" #> [9] "diet_other" "diet_strictly.anything" #> [11] "diet_strictly.halal" "diet_strictly.kosher" #> [13] "diet_strictly.other" "diet_strictly.vegan" #> [15] "diet_strictly.vegetarian" "diet_vegan" #> [17] "diet_vegetarian"# Obtain the full set of dummy variables using `one_hot` option rec %>% step_dummy(diet, one_hot = TRUE) %>% prep(training = okc) %>% bake(new_data = NULL, starts_with("diet")) %>% names() %>% length()#> [1] 18#> [1] 18#> [1] 17#> # A tibble: 18 x 3 #> terms columns id #> <chr> <chr> <chr> #> 1 diet anything dummy_CL8hh #> 2 diet halal dummy_CL8hh #> 3 diet kosher dummy_CL8hh #> 4 diet mostly anything dummy_CL8hh #> 5 diet mostly halal dummy_CL8hh #> 6 diet mostly kosher dummy_CL8hh #> 7 diet mostly other dummy_CL8hh #> 8 diet mostly vegan dummy_CL8hh #> 9 diet mostly vegetarian dummy_CL8hh #> 10 diet other dummy_CL8hh #> 11 diet strictly anything dummy_CL8hh #> 12 diet strictly halal dummy_CL8hh #> 13 diet strictly kosher dummy_CL8hh #> 14 diet strictly other dummy_CL8hh #> 15 diet strictly vegan dummy_CL8hh #> 16 diet strictly vegetarian dummy_CL8hh #> 17 diet vegan dummy_CL8hh #> 18 diet vegetarian dummy_CL8hh