File: prepper.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 (29 lines) | stat: -rw-r--r-- 974 bytes parent folder | download | duplicates (3)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/prepper.R
\name{prepper}
\alias{prepper}
\title{Wrapper function for preparing recipes within resampling}
\usage{
prepper(split_obj, recipe, ...)
}
\arguments{
\item{split_obj}{An \code{rplit} object}

\item{recipe}{An untrained \code{recipe} object.}

\item{...}{Arguments to pass to \code{prep} such as \code{verbose} or \code{retain}.}
}
\description{
When working with the \pkg{rsample} package, a simple recipe
must be \emph{prepared} using the \code{prep}
function first. When using recipes with \pkg{rsample} it
is helpful to have a function that can prepare a recipe
across a series of \code{split} objects that are produced
in this package. \code{prepper} is a wrapper function
around \code{prep} that can be used to do
this. See the vignette on "Recipes and rsample" for an
example.
}
\details{
\code{prepper()} sets the underlying \code{prep()} argument \code{fresh} to \code{TRUE}.
}