-
Notifications
You must be signed in to change notification settings - Fork 11
/
categorize.html
248 lines (187 loc) · 13.5 KB
/
categorize.html
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Categorize and Decategorize Variables in a Data Frame — categorize • sirt</title>
<!-- jquery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
<!-- Bootstrap -->
<link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.3.7/flatly/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>
<!-- Font Awesome icons -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.7.1/css/all.min.css" integrity="sha256-nAmazAk6vS34Xqo0BSrTb+abbtFlgsFK7NKSi6o7Y78=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.7.1/css/v4-shims.min.css" integrity="sha256-6qHlizsOWFskGlwVOKuns+D1nB6ssZrHQrNj1wGplHc=" crossorigin="anonymous" />
<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script>
<!-- headroom.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/headroom.min.js" integrity="sha256-DJFC1kqIhelURkuza0AvYal5RxMtpzLjFhsnVIeuk+U=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script>
<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>
<meta property="og:title" content="Categorize and Decategorize Variables in a Data Frame — categorize" />
<meta property="og:description" content="The function categorize defines categories for variables in
a data frame, starting with a user-defined index (e.g. 0 or 1).
Continuous variables can be categorized by defining categories by
discretizing the variables in different quantile groups.
The function decategorize does the reverse operation." />
<meta name="twitter:card" content="summary" />
<!-- mathjax -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script>
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="container template-reference-topic">
<header>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">sirt</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Versions">3.9-vv</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="../index.html">
<span class="fas fa fas fa-home fa-lg"></span>
</a>
</li>
<li>
<a href="../reference/index.html">Reference</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/alexanderrobitzsch/sirt">
<span class="fab fa fab fa-github fa-lg"></span>
</a>
</li>
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header>
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Categorize and Decategorize Variables in a Data Frame</h1>
<div class="hidden name"><code>categorize.Rd</code></div>
</div>
<div class="ref-description">
<p>The function <code>categorize</code> defines categories for variables in
a data frame, starting with a user-defined index (e.g. 0 or 1).
Continuous variables can be categorized by defining categories by
discretizing the variables in different quantile groups.</p>
<p>The function <code>decategorize</code> does the reverse operation.</p>
</div>
<pre class="usage"><span class='fu'>categorize</span>(<span class='no'>dat</span>, <span class='kw'>categorical</span><span class='kw'>=</span><span class='kw'>NULL</span>, <span class='kw'>quant</span><span class='kw'>=</span><span class='kw'>NULL</span>, <span class='kw'>lowest</span><span class='kw'>=</span><span class='fl'>0</span>)
<span class='fu'>decategorize</span>(<span class='no'>dat</span>, <span class='kw'>categ_design</span><span class='kw'>=</span><span class='kw'>NULL</span>)</pre>
<h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
<table class="ref-arguments">
<colgroup><col class="name" /><col class="desc" /></colgroup>
<tr>
<th>dat</th>
<td><p>Data frame</p></td>
</tr>
<tr>
<th>categorical</th>
<td><p>Vector with variable names which should be converted into categories,
beginning with integer <code>lowest</code></p></td>
</tr>
<tr>
<th>quant</th>
<td><p>Vector with number of classes for each variables.
Variables are categorized among quantiles. The vector must
have names containing variable names.</p></td>
</tr>
<tr>
<th>lowest</th>
<td><p>Lowest category index. Default is 0.</p></td>
</tr>
<tr>
<th>categ_design</th>
<td><p>Data frame containing informations about
categorization which is the output of <code>categorize</code>.</p></td>
</tr>
</table>
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
<p>For <code>categorize</code>, it is a list with entries</p>
<dt>data</dt><dd><p>Converted data frame</p></dd>
<dt>categ_design</dt><dd><p>Data frame containing some informations
about categorization</p></dd>
For decategorize it is a data frame.
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
<pre class="examples"><span class='kw'>if</span> (<span class='fl'>FALSE</span>) {
<span class='fu'><a href='https://rdrr.io/r/base/library.html'>library</a></span>(<span class='no'>mice</span>)
<span class='fu'><a href='https://rdrr.io/r/base/library.html'>library</a></span>(<span class='no'>miceadds</span>)
<span class='co'>#############################################################################</span>
<span class='co'># EXAMPLE 1: Categorize questionnaire data</span>
<span class='co'>#############################################################################</span>
<span class='fu'><a href='https://rdrr.io/r/utils/data.html'>data</a></span>(<span class='no'>data.smallscale</span>, <span class='kw'>package</span><span class='kw'>=</span><span class='st'>"miceadds"</span>)
<span class='no'>dat</span> <span class='kw'><-</span> <span class='no'>data.smallscale</span>
<span class='co'># (0) select dataset</span>
<span class='no'>dat</span> <span class='kw'><-</span> <span class='no'>dat</span>[, <span class='fl'>9</span>:<span class='fl'>20</span> ]
<span class='fu'><a href='https://rdrr.io/r/base/summary.html'>summary</a></span>(<span class='no'>dat</span>)
<span class='no'>categorical</span> <span class='kw'><-</span> <span class='fu'><a href='https://rdrr.io/r/base/colnames.html'>colnames</a></span>(<span class='no'>dat</span>)[<span class='fl'>2</span>:<span class='fl'>6</span>]
<span class='co'># (1) categorize data</span>
<span class='no'>res</span> <span class='kw'><-</span> <span class='kw pkg'>sirt</span><span class='kw ns'>::</span><span class='fu'><a href='https://rdrr.io/pkg/sirt/man/categorize.html'>categorize</a></span>( <span class='no'>dat</span>, <span class='kw'>categorical</span><span class='kw'>=</span><span class='no'>categorical</span> )
<span class='co'># (2) multiple imputation using the mice package</span>
<span class='no'>dat2</span> <span class='kw'><-</span> <span class='no'>res</span>$<span class='no'>data</span>
<span class='no'>VV</span> <span class='kw'><-</span> <span class='fu'><a href='https://rdrr.io/r/base/nrow.html'>ncol</a></span>(<span class='no'>dat2</span>)
<span class='no'>impMethod</span> <span class='kw'><-</span> <span class='fu'><a href='https://rdrr.io/r/base/rep.html'>rep</a></span>( <span class='st'>"sample"</span>, <span class='no'>VV</span> ) <span class='co'># define random sampling imputation method</span>
<span class='fu'><a href='https://rdrr.io/r/base/names.html'>names</a></span>(<span class='no'>impMethod</span>) <span class='kw'><-</span> <span class='fu'><a href='https://rdrr.io/r/base/colnames.html'>colnames</a></span>(<span class='no'>dat2</span>)
<span class='no'>imp</span> <span class='kw'><-</span> <span class='kw pkg'>mice</span><span class='kw ns'>::</span><span class='fu'><a href='http://stefvanbuuren.github.io/mice/reference/mice.html'>mice</a></span>( <span class='fu'><a href='https://rdrr.io/r/base/matrix.html'>as.matrix</a></span>(<span class='no'>dat2</span>), <span class='kw'>impMethod</span><span class='kw'>=</span><span class='no'>impMethod</span>, <span class='kw'>maxit</span><span class='kw'>=</span><span class='fl'>1</span>, <span class='kw'>m</span><span class='kw'>=</span><span class='fl'>1</span> )
<span class='no'>dat3</span> <span class='kw'><-</span> <span class='kw pkg'>mice</span><span class='kw ns'>::</span><span class='fu'><a href='http://stefvanbuuren.github.io/mice/reference/complete.html'>complete</a></span>(<span class='no'>imp</span>,<span class='kw'>action</span><span class='kw'>=</span><span class='fl'>1</span>)
<span class='co'># (3) decategorize dataset</span>
<span class='no'>dat3a</span> <span class='kw'><-</span> <span class='kw pkg'>sirt</span><span class='kw ns'>::</span><span class='fu'><a href='https://rdrr.io/pkg/sirt/man/categorize.html'>decategorize</a></span>( <span class='no'>dat3</span>, <span class='kw'>categ_design</span><span class='kw'>=</span><span class='no'>res</span>$<span class='no'>categ_design</span> )
<span class='co'>#############################################################################</span>
<span class='co'># EXAMPLE 2: Categorize ordinal and continuous data</span>
<span class='co'>#############################################################################</span>
<span class='fu'><a href='https://rdrr.io/r/utils/data.html'>data</a></span>(<span class='no'>data.ma01</span>,<span class='kw'>package</span><span class='kw'>=</span><span class='st'>"miceadds"</span>)
<span class='no'>dat</span> <span class='kw'><-</span> <span class='no'>data.ma01</span>
<span class='fu'><a href='https://rdrr.io/r/base/summary.html'>summary</a></span>(<span class='no'>dat</span>[,-<span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='fl'>1</span>:<span class='fl'>2</span>)] )
<span class='co'># define variables to be categorized</span>
<span class='no'>categorical</span> <span class='kw'><-</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='st'>"books"</span>, <span class='st'>"paredu"</span> )
<span class='co'># define quantiles</span>
<span class='no'>quant</span> <span class='kw'><-</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='fl'>6</span>,<span class='fl'>5</span>,<span class='fl'>11</span>)
<span class='fu'><a href='https://rdrr.io/r/base/names.html'>names</a></span>(<span class='no'>quant</span>) <span class='kw'><-</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='st'>"math"</span>, <span class='st'>"read"</span>, <span class='st'>"hisei"</span>)
<span class='co'># categorize data</span>
<span class='no'>res</span> <span class='kw'><-</span> <span class='kw pkg'>sirt</span><span class='kw ns'>::</span><span class='fu'><a href='https://rdrr.io/pkg/sirt/man/categorize.html'>categorize</a></span>( <span class='no'>dat</span>, <span class='kw'>categorical</span><span class='kw'>=</span><span class='no'>categorical</span>, <span class='kw'>quant</span><span class='kw'>=</span><span class='no'>quant</span>)
<span class='fu'><a href='https://rdrr.io/r/utils/str.html'>str</a></span>(<span class='no'>res</span>)
}</pre>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
<h2>Contents</h2>
<ul class="nav nav-pills nav-stacked">
<li><a href="#arguments">Arguments</a></li>
<li><a href="#value">Value</a></li>
<li><a href="#examples">Examples</a></li>
</ul>
</div>
</div>
<footer>
<div class="copyright">
<p>Developed by Alexander Robitzsch.</p>
</div>
<div class="pkgdown">
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.4.1.</p>
</div>
</footer>
</div>
</body>
</html>