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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rename_at.R
\name{step_rename_at}
\alias{step_rename_at}
\title{Rename multiple columns using dplyr}
\usage{
step_rename_at(
recipe,
...,
fn,
role = "predictor",
trained = FALSE,
inputs = NULL,
skip = FALSE,
id = rand_id("rename_at")
)
}
\arguments{
\item{recipe}{A recipe object. The step will be added to the
sequence of operations for this recipe.}
\item{...}{One or more selector functions to choose variables
for this step. See \code{\link[=selections]{selections()}} for more details.}
\item{fn}{A function \code{fun}, a quosure style lambda `~ fun(.)`` or a list of
either form (but containing only a single function, see \code{\link[dplyr:select_all]{dplyr::rename_at()}}).
\strong{Note that this argument must be named}.}
\item{role}{For model terms created by this step, what analysis role should
they be assigned? By default, the new columns created by this step from
the original variables will be used as \emph{predictors} in a model.}
\item{trained}{A logical to indicate if the quantities for
preprocessing have been estimated.}
\item{inputs}{A vector of column names populated by \code{\link[=prep]{prep()}}.}
\item{skip}{A logical. Should the step be skipped when the
recipe is baked by \code{\link[=bake]{bake()}}? While all operations are baked
when \code{\link[=prep]{prep()}} is run, some operations may not be able to be
conducted on new data (e.g. processing the outcome variable(s)).
Care should be taken when using \code{skip = TRUE} as it may affect
the computations for subsequent operations.}
\item{id}{A character string that is unique to this step to identify it.}
}
\value{
An updated version of \code{recipe} with the new step added to the
sequence of any existing operations.
}
\description{
\code{step_rename_at} creates a \emph{specification} of a recipe step that will rename
the selected variables using a common function via \code{\link[dplyr:select_all]{dplyr::rename_at()}}.
}
\section{Tidying}{
When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns
\code{terms} which contains the columns being transformed is returned.
}
\section{Case weights}{
The underlying operation does not allow for case weights.
}
\examples{
library(dplyr)
recipe(~., data = iris) \%>\%
step_rename_at(everything(), fn = ~ gsub(".", "_", ., fixed = TRUE)) \%>\%
prep() \%>\%
bake(new_data = NULL) \%>\%
slice(1:10)
}
\seealso{
Other dplyr steps:
\code{\link{step_arrange}()},
\code{\link{step_filter}()},
\code{\link{step_mutate_at}()},
\code{\link{step_mutate}()},
\code{\link{step_rename}()},
\code{\link{step_sample}()},
\code{\link{step_select}()},
\code{\link{step_slice}()}
}
\concept{dplyr steps}
|
