Create percentile summaries

tbl_pctile() is a wrapper around mosaic::quantile() and creates a tidy table of data values at the given percentiles.

Usage

tbl_pctile(
  data,
  formula,
  digits = 3,
  probs = c(0, 0.25, 0.5, 0.75, 1),
  caption = NULL
)

Arguments

data

A data frame (or tibble).

formula

Variables to summarize given in formula notation: ~var1 or var1~var2. var1 should be numeric and var2, when supplied, should be a grouping variable.

digits

The number if digits to round to. Defaults to 3.

probs

A vector of percentiles to compute. Each value must be between 0 and 1, inclusive. Defaults to 0, 25%, 50%, 75%, and 100%.

caption

An override for the table caption. A sensible default is given.

Value

An object of class flextable. If in an interactive session, the table will be viewable immediately.

Examples

tbl_pctile(mtcars, ~wt)
Percentiles For wt 
 Missing: 0
0%
25%
50%
75%
100%
1.513
2.581
3.325
3.610
5.424
tbl_pctile(mtcars, ~wt, probs = c(.17, .3, .5, .7, .9, 1))
Percentiles For wt 
 Missing: 0
17%
30%
50%
70%
90%
100%
2.232
2.773
3.325
3.555
4.048
5.424
tbl_pctile(mtcars, wt~cyl, digits = 4)
Percentiles For wt by cyl 
 wt Missing: 0 | cyl Missing: 0
cyl
0%
25%
50%
75%
100%
4
1.5130
1.8850
2.2000
2.6225
3.1900
6
2.6200
2.8225
3.2150
3.4400
3.4600
8
3.1700
3.5325
3.7550
4.0138
5.4240
tbl_pctile(airquality, ~Solar.R)
#> Note: NAs always removed for percentile tables
#> This message is displayed once per session.
Percentiles For Solar.R 
 Missing: 7 | NAs Removed: Yes
0%
25%
50%
75%
100%
7.000
115.750
205.000
258.750
334.000
tbl_pctile(airquality, Month~Solar.R)
Percentiles For Month by Solar.R 
 Month Missing: 0 | Solar.R Missing: 7 | NAs Removed: Yes
Solar.R
0%
25%
50%
75%
100%
7
7.000
7.000
7.000
7.000
7.000
8
5.000
5.000
5.000
5.000
5.000
13
5.000
5.000
5.000
5.000
5.000
14
9.000
9.000
9.000
9.000
9.000
19
5.000
5.000
5.000
5.000
5.000
20
9.000
9.000
9.000
9.000
9.000
24
8.000
8.250
8.500
8.750
9.000
25
5.000
5.000
5.000
5.000
5.000
27
9.000
9.000
9.000
9.000
9.000
31
6.000
6.000
6.000
6.000
6.000
36
8.000
8.000
8.000
8.000
8.000
37
6.000
6.000
6.000
6.000
6.000
44
5.000
5.000
5.000
5.000
5.000
47
6.000
6.000
6.000
6.000
6.000
48
7.000
7.000
7.000
7.000
7.000
49
9.000
9.000
9.000
9.000
9.000
51
8.000
8.000
8.000
8.000
8.000
59
6.000
6.000
6.000
6.000
6.000
64
8.000
8.000
8.000
8.000
8.000
65
5.000
5.000
5.000
5.000
5.000
66
5.000
5.000
5.000
5.000
5.000
71
8.000
8.000
8.000
8.000
8.000
77
8.000
8.000
8.000
8.000
8.000
78
5.000
5.000
5.000
5.000
5.000
81
7.000
7.000
7.000
7.000
7.000
82
7.000
7.000
7.000
7.000
7.000
83
8.000
8.000
8.000
8.000
8.000
91
6.000
6.000
6.000
6.000
6.000
92
5.000
6.000
7.000
8.000
9.000
95
9.000
9.000
9.000
9.000
9.000
98
6.000
6.000
6.000
6.000
6.000
99
5.000
5.000
5.000
5.000
5.000
101
7.000
7.000
7.000
7.000
7.000
112
9.000
9.000
9.000
9.000
9.000
115
8.000
8.000
8.000
8.000
8.000
118
5.000
5.000
5.000
5.000
5.000
120
6.000
6.000
6.000
6.000
6.000
127
6.000
6.000
6.000
6.000
6.000
131
9.000
9.000
9.000
9.000
9.000
135
6.000
6.000
6.000
6.000
6.000
137
6.000
6.500
7.000
7.500
8.000
138
6.000
6.000
6.000
6.000
6.000
139
7.000
7.500
8.000
8.500
9.000
145
9.000
9.000
9.000
9.000
9.000
148
6.000
6.000
6.000
6.000
6.000
149
5.000
5.000
5.000
5.000
5.000
150
6.000
6.000
6.000
6.000
6.000
153
8.000
8.000
8.000
8.000
8.000
157
8.000
8.000
8.000
8.000
8.000
167
9.000
9.000
9.000
9.000
9.000
175
7.000
7.000
7.000
7.000
7.000
183
9.000
9.000
9.000
9.000
9.000
186
6.000
6.000
6.000
6.000
6.000
187
7.000
7.000
7.000
7.000
7.000
188
8.000
8.000
8.000
8.000
8.000
189
9.000
9.000
9.000
9.000
9.000
190
5.000
5.750
6.500
7.250
8.000
191
6.000
6.750
7.500
8.250
9.000
192
8.000
8.000
8.000
8.000
8.000
193
9.000
9.000
9.000
9.000
9.000
194
5.000
5.000
5.000
5.000
5.000
197
9.000
9.000
9.000
9.000
9.000
201
9.000
9.000
9.000
9.000
9.000
203
8.000
8.000
8.000
8.000
8.000
207
8.000
8.000
8.000
8.000
8.000
212
8.000
8.000
8.000
8.000
8.000
213
7.000
7.000
7.000
7.000
7.000
215
8.000
8.000
8.000
8.000
8.000
220
6.000
6.500
7.000
8.000
9.000
222
8.000
8.000
8.000
8.000
8.000
223
5.000
6.000
7.000
8.000
9.000
224
9.000
9.000
9.000
9.000
9.000
225
8.000
8.000
8.000
8.000
8.000
229
8.000
8.000
8.000
8.000
8.000
230
9.000
9.000
9.000
9.000
9.000
236
7.000
7.500
8.000
8.500
9.000
237
8.000
8.250
8.500
8.750
9.000
238
8.000
8.750
9.000
9.000
9.000
242
6.000
6.000
6.000
6.000
6.000
244
8.000
8.000
8.000
8.000
8.000
248
7.000
7.000
7.000
7.000
7.000
250
6.000
6.000
6.000
6.000
6.000
252
5.000
6.000
7.000
8.000
9.000
253
7.000
7.000
7.000
7.000
7.000
254
7.000
7.000
7.000
7.000
7.000
255
8.000
8.000
8.000
8.000
8.000
256
5.000
5.000
5.000
5.000
5.000
258
7.000
7.000
7.000
7.000
7.000
259
6.000
7.500
8.500
9.000
9.000
260
7.000
7.000
7.000
7.000
7.000
264
6.000
6.250
6.500
6.750
7.000
266
5.000
5.000
5.000
5.000
5.000
267
7.000
7.000
7.000
7.000
7.000
269
7.000
7.000
7.000
7.000
7.000
272
7.000
7.000
7.000
7.000
7.000
273
6.000
6.500
7.000
7.500
8.000
274
5.000
5.500
6.000
6.500
7.000
275
7.000
7.000
7.000
7.000
7.000
276
7.000
7.000
7.000
7.000
7.000
279
5.000
5.000
5.000
5.000
5.000
284
6.000
6.000
6.000
6.000
6.000
285
7.000
7.000
7.000
7.000
7.000
286
6.000
6.000
6.000
6.000
6.000
287
6.000
6.000
6.000
6.000
6.000
290
5.000
5.000
5.000
5.000
5.000
291
6.000
6.250
6.500
6.750
7.000
294
7.000
7.000
7.000
7.000
7.000
295
7.000
7.000
7.000
7.000
7.000
299
5.000
5.000
5.000
5.000
5.000
307
5.000
5.000
5.000
5.000
5.000
313
5.000
5.000
5.000
5.000
5.000
314
7.000
7.000
7.000
7.000
7.000
320
5.000
5.000
5.000
5.000
5.000
322
5.000
5.250
5.500
5.750
6.000
323
6.000
6.000
6.000
6.000
6.000
332
6.000
6.000
6.000
6.000
6.000
334
5.000
5.000
5.000
5.000
5.000

try(tbl_pctile(mtcars, ~wt, probs = c(25, 50, 75, 100)))
#> Error in tbl_pctile(mtcars, ~wt, probs = c(25, 50, 75, 100)) : 
#>   You seem to have entered an invalid entry to the `probs` argument. These
#> values should be between 0 and 1 (inclusive).