File: pkg.R

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 (33 lines) | stat: -rw-r--r-- 1,347 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
#' recipes: A package for computing and preprocessing design matrices.
#'
#'The `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 [recipe()], [prep()],
#'   and [bake()].
#'
#' [recipe()] defines the operations on the data and the associated
#'   roles. Once the preprocessing steps are defined, any parameters are
#'   estimated using [prep()]. Once the data are ready for
#'   transformation, the [bake()] function applies the operations.
#'
#' @section Step Functions:
#' These functions are used to add new actions to the recipe and have the
#'   naming convention `"step_action"`. For example,
#'   [step_center()] centers the data to have a zero mean and
#'   [step_dummy()] is used to create dummy variables.
#' @docType package
#' @name recipes
NULL