File: recipes.Rd

package info (click to toggle)
r-cran-recipes 0.1.15%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 2,496 kB
  • sloc: sh: 37; makefile: 2
file content (39 lines) | stat: -rw-r--r-- 1,545 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/pkg.R
\docType{package}
\name{recipes}
\alias{recipes}
\title{recipes: A package for computing and preprocessing design matrices.}
\description{
The \code{recipes} package can be used to create design matrices for modeling
and to conduct preprocessing of variables. It is meant to be a more
extensive framework that R's formula method. Some differences between
simple formula methods and recipes are that
\enumerate{
\item Variables can have arbitrary roles in the analysis beyond predictors
and outcomes.
\item A recipe consists of one or more steps that define actions on the
variables.
\item Recipes can be defined sequentially using pipes as well as being
modifiable and extensible.
}
}
\section{Basic Functions}{

The three main functions are \code{\link[=recipe]{recipe()}}, \code{\link[=prep]{prep()}},
and \code{\link[=bake]{bake()}}.

\code{\link[=recipe]{recipe()}} defines the operations on the data and the associated
roles. Once the preprocessing steps are defined, any parameters are
estimated using \code{\link[=prep]{prep()}}. Once the data are ready for
transformation, the \code{\link[=bake]{bake()}} function applies the operations.
}

\section{Step Functions}{

These functions are used to add new actions to the recipe and have the
naming convention \code{"step_action"}. For example,
\code{\link[=step_center]{step_center()}} centers the data to have a zero mean and
\code{\link[=step_dummy]{step_dummy()}} is used to create dummy variables.
}