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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/num2factor.R
\name{step_num2factor}
\alias{step_num2factor}
\title{Convert Numbers to Factors}
\usage{
step_num2factor(
recipe,
...,
role = NA,
transform = function(x) x,
trained = FALSE,
levels,
ordered = FALSE,
skip = FALSE,
id = rand_id("num2factor")
)
}
\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{role}{Not used by this step since no new variables are
created.}
\item{transform}{A function taking a single argument \code{x} that can be used
to modify the numeric values prior to determining the levels (perhaps using
\code{\link[base:integer]{base::as.integer()}}). The output of a function should be an integer that
corresponds to the value of \code{levels} that should be assigned. If not an
integer, the value will be converted to an integer during \code{\link[=bake]{bake()}}.}
\item{trained}{A logical to indicate if the quantities for
preprocessing have been estimated.}
\item{levels}{A character vector of values that will be used as the levels.
These are the numeric data converted to character and ordered. This is
modified once \code{\link[=prep]{prep()}} is executed.}
\item{ordered}{A single logical value; should the factor(s) be ordered?}
\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_num2factor} will convert one or more numeric vectors to factors
(ordered or unordered). This can be useful when categories are encoded as
integers.
}
\section{Tidying}{
When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns
\code{terms} (the selectors or variables selected) and \code{ordered} is returned.
}
\section{Case weights}{
The underlying operation does not allow for case weights.
}
\examples{
\dontshow{if (rlang::is_installed("modeldata")) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
library(dplyr)
data(attrition, package = "modeldata")
attrition \%>\%
group_by(StockOptionLevel) \%>\%
count()
amnt <- c("nothin", "meh", "some", "copious")
rec <-
recipe(Attrition ~ StockOptionLevel, data = attrition) \%>\%
step_num2factor(
StockOptionLevel,
transform = function(x) x + 1,
levels = amnt
)
encoded <- rec \%>\%
prep() \%>\%
bake(new_data = NULL)
table(encoded$StockOptionLevel, attrition$StockOptionLevel)
# an example for binning
binner <- function(x) {
x <- cut(x, breaks = 1000 * c(0, 5, 10, 20), include.lowest = TRUE)
# now return the group number
as.numeric(x)
}
inc <- c("low", "med", "high")
rec <-
recipe(Attrition ~ MonthlyIncome, data = attrition) \%>\%
step_num2factor(
MonthlyIncome,
transform = binner,
levels = inc,
ordered = TRUE
) \%>\%
prep()
encoded <- bake(rec, new_data = NULL)
table(encoded$MonthlyIncome, binner(attrition$MonthlyIncome))
# What happens when a value is out of range?
ceo <- attrition \%>\%
slice(1) \%>\%
mutate(MonthlyIncome = 10^10)
bake(rec, ceo)
\dontshow{\}) # examplesIf}
}
\seealso{
Other dummy variable and encoding steps:
\code{\link{step_bin2factor}()},
\code{\link{step_count}()},
\code{\link{step_date}()},
\code{\link{step_dummy_extract}()},
\code{\link{step_dummy_multi_choice}()},
\code{\link{step_dummy}()},
\code{\link{step_factor2string}()},
\code{\link{step_holiday}()},
\code{\link{step_indicate_na}()},
\code{\link{step_integer}()},
\code{\link{step_novel}()},
\code{\link{step_ordinalscore}()},
\code{\link{step_other}()},
\code{\link{step_regex}()},
\code{\link{step_relevel}()},
\code{\link{step_string2factor}()},
\code{\link{step_time}()},
\code{\link{step_unknown}()},
\code{\link{step_unorder}()}
}
\concept{dummy variable and encoding steps}
|
