reorder.html
4.5 KB
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><title>R: Reorder the Levels of a Factor</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link rel="stylesheet" type="text/css" href="../../R.css">
</head><body>
<table width="100%" summary="page for reorder.factor {gdata}"><tr><td>reorder.factor {gdata}</td><td align="right">R Documentation</td></tr></table>
<h2>Reorder the Levels of a Factor</h2>
<h3>Description</h3>
<p>
Reorder the levels of a factor
</p>
<h3>Usage</h3>
<pre>
## S3 method for class 'factor':
reorder(x,
X,
FUN,
...,
order=is.ordered(x),
new.order,
sort=mixedsort)
</pre>
<h3>Arguments</h3>
<table summary="R argblock">
<tr valign="top"><td><code>x</code></td>
<td>
factor</td></tr>
<tr valign="top"><td><code>X</code></td>
<td>
auxillary data vector</td></tr>
<tr valign="top"><td><code>FUN</code></td>
<td>
function to be applied to subsets of <code>X</code> determined by
<code>x</code>, to determine factor order</td></tr>
<tr valign="top"><td><code>...</code></td>
<td>
optional parameters to <code>FUN</code></td></tr>
<tr valign="top"><td><code>order</code></td>
<td>
logical value indicating whether the returned
object should be an <code><a href="../../base/html/factor.html">ordered</a></code> factor</td></tr>
<tr valign="top"><td><code>new.order</code></td>
<td>
a vector of indexes or a vector of label names giving
the order of the new factor levels</td></tr>
<tr valign="top"><td><code>sort</code></td>
<td>
function to use to sort the factor level names, used only
when <code>new.order</code> is missing</td></tr>
</table>
<h3>Details</h3>
<p>
This function changes the order of the levels of a factor. It can do
so via three different mechanisms, depending on whether, <code>X</code>
<EM>and</EM> <code>FUN</code>, <code>new.order</code> or <code>sort</code> are provided.
</p>
<p>
If <code>X</code> <EM>and</EM> <code>Fun</code> are provided: The data in <code>X</code>
is grouped by the levels of <code>x</code> and <code>FUN</code> is applied.
The groups are then sorted by this value, and the resulting order is
used for the new factor level names.
</p>
<p>
If <code>new.order</code> is provided: For a numeric vector, the new factor
level names are constructed by reordering the factor levels according
to the numeric values. For vectors, <code>new.order</code> gives the list of
new factor level names. In either case levels omitted from
<code>new.order</code> will become missing (<code>NA</code>) values.
</p>
<p>
If <code>sort</code> is provided (as it is by default): The new
factor level names are generated by applying the supplied function
to the existing factor level names. With <code>sort=mixedsort</code> the
factor levels are sorted so that combined numeric and character
strings are sorted in according to character rules on the character
sections (including ignoring case), and the numeric rules for the
numeric sections. See <code><a href="../../gtools/html/mixedsort.html">mixedsort</a></code> for details.
</p>
<h3>Value</h3>
<p>
A new factor with reordered levels</p>
<h3>Author(s)</h3>
<p>
Gregory R. Warnes <a href="mailto:warnes@bst.rochester.edu">warnes@bst.rochester.edu</a>
</p>
<h3>See Also</h3>
<p>
<code><a href="../../base/html/factor.html">factor</a></code> and <code><a href="../../stats/html/reorder.html">reorder</a></code>
</p>
<h3>Examples</h3>
<pre>
# Create a 4 level example factor
trt <- factor( sample( c("PLACEBO", "300 MG", "600 MG", "1200 MG"),
100, replace=TRUE ) )
summary(trt)
# Note that the levels are not in a meaningful order.
# Change the order to something useful
# default "mixedsort" ordering
trt2 <- reorder(trt)
summary(trt2)
# using indexes:
trt3 <- reorder(trt, new.order=c(4, 2, 3, 1))
summary(trt3)
# using label names:
trt4 <- reorder(trt, new.order=c("PLACEBO", "300 MG", "600 MG", "1200 MG"))
summary(trt4)
# using frequency
trt5 <- reorder(trt, X=as.numeric(trt), FUN=length)
summary(trt5)
# drop out the '300 MG' level
trt6 <- reorder(trt, new.order=c("PLACEBO", "600 MG", "1200 MG"))
summary(trt6)
</pre>
<hr><div align="center">[Package <em>gdata</em> version 2.3.1 <a href="00Index.html">Index]</a></div>
</body></html>