In our Build a Model article, we learned how to specify and train models with different engines using the parsnip package. In this article, we’ll explore another tidymodels package, recipes, which is designed to help you preprocess your data before training your model. Recipes are built as a series of preprocessing steps, such as:
converting qualitative predictors to indicator variables (also known as dummy variables),
transforming data to be on a different scale (e.g., taking the logarithm of a variable),
transforming whole groups of predictors together,
extracting key features from raw variables (e.g., getting the day of the week out of a date variable),
and so on. If you are familiar with R’s formula interface, a lot of this might sound familiar and like what a formula already does. Recipes can be used to do many of the same things, but they have a much wider range of possibilities. This article shows how to use recipes for modeling.
To use code in this article, you will need to install the following packages: nycflights13, skimr, and tidymodels.
library(tidymodels) # for the recipes package, along with the rest of tidymodels # Helper packages library(nycflights13) # for flight data library(skimr) # for variable summaries
Alternatively, open an interactive version of this article in your browser:
The New York City flight data 🔗︎
Let’s use the nycflights13 data to predict whether a plane arrives more than 30 minutes late. This data set contains information on 325,819 flights departing near New York City in 2013. Let’s start by loading the data and making a few changes to the variables:
set.seed(123) flight_data <- flights %>% mutate( # Convert the arrival delay to a factor arr_delay = ifelse(arr_delay >= 30, "late", "on_time"), arr_delay = factor(arr_delay), # We will use the date (not date-time) in the recipe below date = lubridate::as_date(time_hour) ) %>% # Include the weather data inner_join(weather, by = c("origin", "time_hour")) %>% # Only retain the specific columns we will use select(dep_time, flight, origin, dest, air_time, distance, carrier, date, arr_delay, time_hour) %>% # Exclude missing data na.omit() %>% # For creating models, it is better to have qualitative columns # encoded as factors (instead of character strings) mutate_if(is.character, as.factor)
We can see that about 16% of the flights in this data set arrived more than 30 minutes late.
flight_data %>% count(arr_delay) %>% mutate(prop = n/sum(n)) #> # A tibble: 2 × 3 #> arr_delay n prop #> <fct> <int> <dbl> #> 1 late 52540 0.161 #> 2 on_time 273279 0.839
Before we start building up our recipe, let’s take a quick look at a few specific variables that will be important for both preprocessing and modeling.
First, notice that the variable we created called
arr_delay is a factor variable; it is important that our outcome variable for training a logistic regression model is a factor.
glimpse(flight_data) #> Rows: 325,819 #> Columns: 10 #> $ dep_time <int> 517, 533, 542, 544, 554, 554, 555, 557, 557, 558, 558, 558, … #> $ flight <int> 1545, 1714, 1141, 725, 461, 1696, 507, 5708, 79, 301, 49, 71… #> $ origin <fct> EWR, LGA, JFK, JFK, LGA, EWR, EWR, LGA, JFK, LGA, JFK, JFK, … #> $ dest <fct> IAH, IAH, MIA, BQN, ATL, ORD, FLL, IAD, MCO, ORD, PBI, TPA, … #> $ air_time <dbl> 227, 227, 160, 183, 116, 150, 158, 53, 140, 138, 149, 158, 3… #> $ distance <dbl> 1400, 1416, 1089, 1576, 762, 719, 1065, 229, 944, 733, 1028,… #> $ carrier <fct> UA, UA, AA, B6, DL, UA, B6, EV, B6, AA, B6, B6, UA, UA, AA, … #> $ date <date> 2013-01-01, 2013-01-01, 2013-01-01, 2013-01-01, 2013-01-01,… #> $ arr_delay <fct> on_time, on_time, late, on_time, on_time, on_time, on_time, … #> $ time_hour <dttm> 2013-01-01 05:00:00, 2013-01-01 05:00:00, 2013-01-01 05:00:…
Second, there are two variables that we don’t want to use as predictors in our model, but that we would like to retain as identification variables that can be used to troubleshoot poorly predicted data points. These are
flight, a numeric value, and
time_hour, a date-time value.
Third, there are 104 flight destinations contained in
dest and 16 distinct
flight_data %>% skimr::skim(dest, carrier)
|Number of rows||325819|
|Number of columns||10|
|Column type frequency:|
Variable type: factor
|dest||0||1||FALSE||104||ATL: 16771, ORD: 16507, LAX: 15942, BOS: 14948|
|carrier||0||1||FALSE||16||UA: 57489, B6: 53715, EV: 50868, DL: 47465|
Because we’ll be using a simple logistic regression model, the variables
carrier will be converted to dummy variables. However, some of these values do not occur very frequently and this could complicate our analysis. We’ll discuss specific steps later in this article that we can add to our recipe to address this issue before modeling.
Data splitting 🔗︎
To get started, let’s split this single dataset into two: a training set and a testing set. We’ll keep most of the rows in the original dataset (subset chosen randomly) in the training set. The training data will be used to fit the model, and the testing set will be used to measure model performance.
To do this, we can use the rsample package to create an object that contains the information on how to split the data, and then two more rsample functions to create data frames for the training and testing sets:
# Fix the random numbers by setting the seed # This enables the analysis to be reproducible when random numbers are used set.seed(222) # Put 3/4 of the data into the training set data_split <- initial_split(flight_data, prop = 3/4) # Create data frames for the two sets: train_data <- training(data_split) test_data <- testing(data_split)
Create recipe and roles 🔗︎
To get started, let’s create a recipe for a simple logistic regression model. Before training the model, we can use a recipe to create a few new predictors and conduct some preprocessing required by the model.
Let’s initiate a new recipe:
flights_rec <- recipe(arr_delay ~ ., data = train_data)
recipe() function as we used it here has two arguments:
A formula. Any variable on the left-hand side of the tilde (
~) is considered the model outcome (here,
arr_delay). On the right-hand side of the tilde are the predictors. Variables may be listed by name, or you can use the dot (
.) to indicate all other variables as predictors.
The data. A recipe is associated with the data set used to create the model. This will typically be the training set, so
data = train_datahere. Naming a data set doesn’t actually change the data itself; it is only used to catalog the names of the variables and their types, like factors, integers, dates, etc.
Now we can add roles to this recipe. We can use the
update_role() function to let recipes know that
time_hour are variables with a custom role that we called
"ID" (a role can have any character value). Whereas our formula included all variables in the training set other than
arr_delay as predictors, this tells the recipe to keep these two variables but not use them as either outcomes or predictors.
flights_rec <- recipe(arr_delay ~ ., data = train_data) %>% update_role(flight, time_hour, new_role = "ID")
This step of adding roles to a recipe is optional; the purpose of using it here is that those two variables can be retained in the data but not included in the model. This can be convenient when, after the model is fit, we want to investigate some poorly predicted value. These ID columns will be available and can be used to try to understand what went wrong.
To get the current set of variables and roles, use the
summary(flights_rec) #> # A tibble: 10 × 4 #> variable type role source #> <chr> <chr> <chr> <chr> #> 1 dep_time numeric predictor original #> 2 flight numeric ID original #> 3 origin nominal predictor original #> 4 dest nominal predictor original #> 5 air_time numeric predictor original #> 6 distance numeric predictor original #> 7 carrier nominal predictor original #> 8 date date predictor original #> 9 time_hour date ID original #> 10 arr_delay nominal outcome original
Create features 🔗︎
Now we can start adding steps onto our recipe using the pipe operator. Perhaps it is reasonable for the date of the flight to have an effect on the likelihood of a late arrival. A little bit of feature engineering might go a long way to improving our model. How should the date be encoded into the model? The
date column has an R
date object so including that column “as is” will mean that the model will convert it to a numeric format equal to the number of days after a reference date:
flight_data %>% distinct(date) %>% mutate(numeric_date = as.numeric(date)) #> # A tibble: 364 × 2 #> date numeric_date #> <date> <dbl> #> 1 2013-01-01 15706 #> 2 2013-01-02 15707 #> 3 2013-01-03 15708 #> 4 2013-01-04 15709 #> 5 2013-01-05 15710 #> # … with 359 more rows
It’s possible that the numeric date variable is a good option for modeling; perhaps the model would benefit from a linear trend between the log-odds of a late arrival and the numeric date variable. However, it might be better to add model terms derived from the date that have a better potential to be important to the model. For example, we could derive the following meaningful features from the single
the day of the week,
the month, and
whether or not the date corresponds to a holiday.
Let’s do all three of these by adding steps to our recipe:
flights_rec <- recipe(arr_delay ~ ., data = train_data) %>% update_role(flight, time_hour, new_role = "ID") %>% step_date(date, features = c("dow", "month")) %>% step_holiday(date, holidays = timeDate::listHolidays("US"), keep_original_cols = FALSE)
What do each of these steps do?
step_date(), we created two new factor columns with the appropriate day of the week and the month.
step_holiday(), we created a binary variable indicating whether the current date is a holiday or not. The argument value of
timeDate::listHolidays("US")uses the timeDate package to list the 17 standard US holidays.
keep_original_cols = FALSE, we remove the original
datevariable since we no longer want it in the model. Many recipe steps that create new variables have this argument.
Next, we’ll turn our attention to the variable types of our predictors. Because we plan to train a logistic regression model, we know that predictors will ultimately need to be numeric, as opposed to nominal data like strings and factor variables. In other words, there may be a difference in how we store our data (in factors inside a data frame), and how the underlying equations require them (a purely numeric matrix).
For factors like
origin, standard practice is to convert them into dummy or indicator variables to make them numeric. These are binary values for each level of the factor. For example, our
origin variable has values of
"LGA". The standard dummy variable encoding, shown below, will create two numeric columns of the data that are 1 when the originating airport is
"LGA" and zero otherwise, respectively.
But, unlike the standard model formula methods in R, a recipe does not automatically create these dummy variables for you; you’ll need to tell your recipe to add this step. This is for two reasons. First, many models do not require numeric predictors, so dummy variables may not always be preferred. Second, recipes can also be used for purposes outside of modeling, where non-dummy versions of the variables may work better. For example, you may want to make a table or a plot with a variable as a single factor. For those reasons, you need to explicitly tell recipes to create dummy variables using
flights_rec <- recipe(arr_delay ~ ., data = train_data) %>% update_role(flight, time_hour, new_role = "ID") %>% step_date(date, features = c("dow", "month")) %>% step_holiday(date, holidays = timeDate::listHolidays("US"), keep_original_cols = FALSE) %>% step_dummy(all_nominal_predictors())
Here, we did something different than before: instead of applying a step to an individual variable, we used selectors to apply this recipe step to several variables at once,
all_nominal_predictors(). The selector functions can be combined to select intersections of variables.
At this stage in the recipe, this step selects the
carrier variables. It also includes two new variables,
date_month, that were created by the earlier
More generally, the recipe selectors mean that you don’t always have to apply steps to individual variables one at a time. Since a recipe knows the variable type and role of each column, they can also be selected (or dropped) using this information.
We need one final step to add to our recipe. Since
dest have some infrequently occurring factor values, it is possible that dummy variables might be created for values that don’t exist in the training set. For example, there is one destination that is only in the test set:
test_data %>% distinct(dest) %>% anti_join(train_data) #> Joining, by = "dest" #> # A tibble: 1 × 1 #> dest #> <fct> #> 1 LEX
When the recipe is applied to the training set, a column is made for LEX because the factor levels come from
flight_data (not the training set), but this column will contain all zeros. This is a “zero-variance predictor” that has no information within the column. While some R functions will not produce an error for such predictors, it usually causes warnings and other issues.
step_zv() will remove columns from the data when the training set data have a single value, so it is added to the recipe after
flights_rec <- recipe(arr_delay ~ ., data = train_data) %>% update_role(flight, time_hour, new_role = "ID") %>% step_date(date, features = c("dow", "month")) %>% step_holiday(date, holidays = timeDate::listHolidays("US"), keep_original_cols = FALSE) %>% step_dummy(all_nominal_predictors()) %>% step_zv(all_predictors())
Now we’ve created a specification of what should be done with the data. How do we use the recipe we made?
Fit a model with a recipe 🔗︎
lr_mod <- logistic_reg() %>% set_engine("glm")
We will want to use our recipe across several steps as we train and test our model. We will:
Process the recipe using the training set: This involves any estimation or calculations based on the training set. For our recipe, the training set will be used to determine which predictors should be converted to dummy variables and which predictors will have zero-variance in the training set, and should be slated for removal.
Apply the recipe to the training set: We create the final predictor set on the training set.
Apply the recipe to the test set: We create the final predictor set on the test set. Nothing is recomputed and no information from the test set is used here; the dummy variable and zero-variance results from the training set are applied to the test set.
To simplify this process, we can use a model workflow, which pairs a model and recipe together. This is a straightforward approach because different recipes are often needed for different models, so when a model and recipe are bundled, it becomes easier to train and test workflows. We’ll use the workflows package from tidymodels to bundle our parsnip model (
lr_mod) with our recipe (
flights_wflow <- workflow() %>% add_model(lr_mod) %>% add_recipe(flights_rec) flights_wflow #> ══ Workflow ══════════════════════════════════════════════════════════ #> Preprocessor: Recipe #> Model: logistic_reg() #> #> ── Preprocessor ────────────────────────────────────────────────────── #> 4 Recipe Steps #> #> • step_date() #> • step_holiday() #> • step_dummy() #> • step_zv() #> #> ── Model ───────────────────────────────────────────────────────────── #> Logistic Regression Model Specification (classification) #> #> Computational engine: glm
Now, there is a single function that can be used to prepare the recipe and train the model from the resulting predictors:
flights_fit <- flights_wflow %>% fit(data = train_data)
This object has the finalized recipe and fitted model objects inside. You may want to extract the model or recipe objects from the workflow. To do this, you can use the helper functions
extract_recipe(). For example, here we pull the fitted model object then use the
broom::tidy() function to get a tidy tibble of model coefficients:
flights_fit %>% extract_fit_parsnip() %>% tidy() #> # A tibble: 157 × 5 #> term estimate std.error statistic p.value #> <chr> <dbl> <dbl> <dbl> <dbl> #> 1 (Intercept) 7.28 2.73 2.67 7.64e- 3 #> 2 dep_time -0.00166 0.0000141 -118. 0 #> 3 air_time -0.0440 0.000563 -78.2 0 #> 4 distance 0.00507 0.00150 3.38 7.32e- 4 #> 5 date_USChristmasDay 1.33 0.177 7.49 6.93e-14 #> # … with 152 more rows
Use a trained workflow to predict 🔗︎
Our goal was to predict whether a plane arrives more than 30 minutes late. We have just:
Built the model (
Created a preprocessing recipe (
Bundled the model and recipe (
Trained our workflow using a single call to
The next step is to use the trained workflow (
flights_fit) to predict with the unseen test data, which we will do with a single call to
predict() method applies the recipe to the new data, then passes them to the fitted model.
predict(flights_fit, test_data) #> # A tibble: 81,455 × 1 #> .pred_class #> <fct> #> 1 on_time #> 2 on_time #> 3 on_time #> 4 on_time #> 5 on_time #> # … with 81,450 more rows
Because our outcome variable here is a factor, the output from
predict() returns the predicted class:
on_time. But, let’s say we want the predicted class probabilities for each flight instead. To return those, we can specify
type = "prob" when we use
predict() or use
augment() with the model plus test data to save them together:
flights_aug <- augment(flights_fit, test_data) # The data look like: flights_aug %>% select(arr_delay, time_hour, flight, .pred_class, .pred_on_time) #> # A tibble: 81,455 × 5 #> arr_delay time_hour flight .pred_class .pred_on_time #> <fct> <dttm> <int> <fct> <dbl> #> 1 on_time 2013-01-01 05:00:00 1545 on_time 0.945 #> 2 on_time 2013-01-01 05:00:00 1714 on_time 0.949 #> 3 on_time 2013-01-01 06:00:00 507 on_time 0.964 #> 4 on_time 2013-01-01 06:00:00 5708 on_time 0.961 #> 5 on_time 2013-01-01 06:00:00 71 on_time 0.962 #> # … with 81,450 more rows
Now that we have a tibble with our predicted class probabilities, how will we evaluate the performance of our workflow? We can see from these first few rows that our model predicted these 5 on time flights correctly because the values of
.pred_on_time are p > .50. But we also know that we have 81,455 rows total to predict. We would like to calculate a metric that tells how well our model predicted late arrivals, compared to the true status of our outcome variable,
To generate a ROC curve, we need the predicted class probabilities for
on_time, which we just calculated in the code chunk above. We can create the ROC curve with these values, using
roc_curve() and then piping to the
flights_aug %>% roc_curve(truth = arr_delay, .pred_late) %>% autoplot()
roc_auc() estimates the area under the curve:
flights_aug %>% roc_auc(truth = arr_delay, .pred_late) #> # A tibble: 1 × 3 #> .metric .estimator .estimate #> <chr> <chr> <dbl> #> 1 roc_auc binary 0.764
Not too bad! We leave it to the reader to test out this workflow without this recipe. You can use
workflows::add_formula(arr_delay ~ .) instead of
add_recipe() (remember to remove the identification variables first!), and see whether our recipe improved our model’s ability to predict late arrivals.
Session information 🔗︎
#> ─ Session info ───────────────────────────────────────────────────── #> setting value #> version R version 4.1.1 (2021-08-10) #> os macOS Monterey 12.2.1 #> system aarch64, darwin20 #> ui X11 #> language (EN) #> collate en_US.UTF-8 #> ctype en_US.UTF-8 #> tz America/Denver #> date 2022-03-23 #> pandoc 188.8.131.52 @ /Applications/RStudio.app/Contents/MacOS/quarto/bin/ (via rmarkdown) #> #> ─ Packages ───────────────────────────────────────────────────────── #> package * version date (UTC) lib source #> broom * 0.7.12 2022-01-28  CRAN (R 4.1.1) #> dials * 0.1.0 2022-01-31  CRAN (R 4.1.1) #> dplyr * 1.0.8 2022-02-08  CRAN (R 4.1.1) #> ggplot2 * 3.3.5 2021-06-25  CRAN (R 4.1.0) #> infer * 1.0.0 2021-08-13  CRAN (R 4.1.1) #> nycflights13 * 1.0.2 2021-04-12  CRAN (R 4.1.0) #> parsnip * 0.2.1 2022-03-17  CRAN (R 4.1.1) #> purrr * 0.3.4 2020-04-17  CRAN (R 4.1.0) #> recipes * 0.2.0 2022-02-18  CRAN (R 4.1.1) #> rlang 1.0.2 2022-03-04  CRAN (R 4.1.1) #> rsample * 0.1.1 2021-11-08  CRAN (R 4.1.1) #> skimr * 2.1.3 2021-03-07  CRAN (R 4.1.0) #> tibble * 3.1.6 2021-11-07  CRAN (R 4.1.1) #> tidymodels * 0.2.0 2022-03-19  CRAN (R 4.1.1) #> tune * 0.2.0 2022-03-19  CRAN (R 4.1.1) #> workflows * 0.2.6 2022-03-18  CRAN (R 4.1.1) #> yardstick * 0.0.9 2021-11-22  CRAN (R 4.1.1) #> #>  /Library/Frameworks/R.framework/Versions/4.1-arm64/Resources/library #> #> ────────────────────────────────────────────────────────────────────