forked from mjskay/tidybayes
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtidy-rstanarm.Rmd
executable file
·701 lines (526 loc) · 27.6 KB
/
tidy-rstanarm.Rmd
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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
---
title: "Extracting and visualizing tidy draws from rstanarm models"
author: "Matthew Kay"
date: "`r Sys.Date()`"
output:
rmarkdown::html_vignette:
toc: true
df_print: kable
params:
EVAL: !r identical(Sys.getenv("NOT_CRAN"), "true")
vignette: >
%\VignetteIndexEntry{Extracting and visualizing tidy draws from rstanarm models}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---
<style type="text/css">
.kable-table table {
margin-left: 0;
}
img {
border: none;
}
</style>
```{r chunk_options, include=FALSE}
# if (requireNamespace("pkgdown", quietly = TRUE) && pkgdown::in_pkgdown()) {
tiny_width = small_width = med_width = 6.75
tiny_height = small_height = med_height = 4.5
large_width = 8; large_height = 5.25
# } else {
# tiny_width = 3; tiny_height = 2.5
# small_width = 4.5; small_height = 3
# med_width = 5; med_height = 3.5
# large_width = 7; large_height = 4.5
# }
knitr::opts_chunk$set(
fig.width = small_width,
fig.height = small_height,
eval = if (isTRUE(exists("params"))) params$EVAL else FALSE
)
if (capabilities("cairo") && Sys.info()[['sysname']] != "Darwin") {
knitr::opts_chunk$set(
dev.args = list(png = list(type = "cairo"))
)
}
```
## Introduction
This vignette describes how to use the `tidybayes` and `ggdist` packages to extract and visualize [tidy](https://dx.doi.org/10.18637/jss.v059.i10) data frames of draws from posterior distributions of model variables, fits, and predictions from `rstanarm`. For a more general introduction to `tidybayes` and its use on general-purpose Bayesian modeling languages (like Stan and JAGS), see `vignette("tidybayes")`.
## Setup
The following libraries are required to run this vignette:
```{r setup, message = FALSE, warning = FALSE}
library(magrittr)
library(dplyr)
library(purrr)
library(forcats)
library(tidyr)
library(modelr)
library(ggdist)
library(tidybayes)
library(ggplot2)
library(cowplot)
library(rstan)
library(rstanarm)
library(RColorBrewer)
library(gganimate)
theme_set(theme_tidybayes() + panel_border())
```
These options help Stan run faster:
```{r, eval=FALSE}
rstan_options(auto_write = TRUE)
options(mc.cores = parallel::detectCores())
```
```{r hidden_options, include=FALSE}
# While the previous code chunk is the actual recommended approach,
# CRAN vignette building policy limits us to 2 cores, so we use at most
# 2 to build this vignette (but show the previous chunk to
# the reader as a best pratice example)
rstan_options(auto_write = TRUE)
options(mc.cores = min(2, parallel::detectCores()))
options(width = 120)
```
## Example dataset
To demonstrate `tidybayes`, we will use a simple dataset with 10 observations from 5 conditions each:
```{r}
set.seed(5)
n = 10
n_condition = 5
ABC =
tibble(
condition = rep(c("A","B","C","D","E"), n),
response = rnorm(n * 5, c(0,1,2,1,-1), 0.5)
)
```
A snapshot of the data looks like this:
```{r}
head(ABC, 10)
```
This is a typical tidy format data frame: one observation per row. Graphically:
```{r fig.width = tiny_width, fig.height = tiny_height}
ABC %>%
ggplot(aes(y = condition, x = response)) +
geom_point()
```
## Model
Let's fit a hierarchical model with shrinkage towards a global mean:
```{r}
m = stan_lmer(response ~ (1|condition), data = ABC,
prior = normal(0, 1, autoscale = FALSE),
prior_aux = student_t(3, 0, 1, autoscale = FALSE),
adapt_delta = .99)
```
The results look like this:
```{r}
m
```
## Extracting draws from a fit in tidy-format using `spread_draws`
Now that we have our results, the fun begins: getting the draws out in a tidy format! First, we'll use the `get_variables()` function to get a list of raw model variables names so that we know what variables we can extract from the model:
```{r}
get_variables(m)
```
Here, `(Intercept)` is the global mean, and the `b` parameters are offsets from that mean for each condition. Given these parameters:
- `b[(Intercept) condition:A]`
- `b[(Intercept) condition:B]`
- `b[(Intercept) condition:C]`
- `b[(Intercept) condition:D]`
- `b[(Intercept) condition:E]`
We might want a data frame where each row is a draw from either `b[(Intercept) condition:A]`, `b[(Intercept) condition:B]`, `...:C]`, `...:D]`, or `...:E]`, and where we have columns indexing which chain/iteration/draw the row came from and which condition (`A` to `E`) it is for. That would allow us to easily compute quantities grouped by condition, or generate plots by condition using ggplot, or even merge draws with the original data to plot data and posteriors.
The workhorse of `tidybayes` is the `spread_draws()` function, which does this extraction for us. It includes a simple specification format that we can use to extract model variables and their indices into tidy-format data frames.
### Gathering variable indices into a separate column in a tidy format data frame
Given a parameter like this:
`b[(Intercept) condition:D]`
We can provide `spread_draws()` with a column specification like this:
`b[term,group]`
Where `term` corresponds to `(Intercept)` and `group` to `condition:D`. There is nothing too magical about what `spread_draws()` does with this specification: under the hood, it splits the parameter indices by commas and spaces (you can split by other characters by changing the `sep` argument). It lets you assign columns to the resulting indices in order. So `b[(Intercept) condition:D]` has indices `(Intercept)` and `condition:D`, and `spread_draws()` lets us extract these indices as columns in the resulting tidy data frame of draws from `b`:
```{r}
m %>%
spread_draws(b[term,group]) %>%
head(10)
```
We can choose whatever names we want for the index columns; e.g.:
```{r}
m %>%
spread_draws(b[t,g]) %>%
head(10)
```
But the more descriptive and less cryptic names from the previous example are probably preferable.
In this particular model, there is only one term (`(Intercept)`), thus we could omit that index altogether to just get each `group` and the value of `b` for the corresponding condition:
```{r}
m %>%
spread_draws(b[,group]) %>%
head(10)
```
Since all the groups in this case are from the `condition` factor, we may also want to separate out a column just containing the corresponding condition (`A`, `B`, `C`, etc). We can do that using `tidyr::separate`:
```{r}
m %>%
spread_draws(b[,group]) %>%
separate(group, c("group", "condition"), ":") %>%
head(10)
```
Alternatively, we could change the `sep` argument to `spread_draws()` to also split on `:` (`sep` is a regular expression). __Note:__ This works in this example, but will not work well on rstanarm models where interactions between factors are used as grouping levels in a multilevel model, thus `:` is not included in the default separators.
```{r}
m %>%
spread_draws(b[,group,condition], sep = "[, :]") %>%
head(10)
```
__Note:__ If you have used `spread_draws()` with a raw sample from Stan or JAGS, you may be used to using `recover_types()` before `spread_draws()` to get index column values back (e.g. if the index was a factor). This is not necessary when using `spread_draws()` on `rstanarm` models, because those models already contain that information in their variable names. For more on `recover_types()`, see `vignette("tidybayes")`.
## Point summaries and intervals
### With simple model variables
`tidybayes` provides a family of functions for generating point summaries and intervals from draws in a tidy format. These functions follow the naming scheme `[median|mean|mode]_[qi|hdi]`, for example, `median_qi()`, `mean_qi()`, `mode_hdi()`, and so on. The first name (before the `_`) indicates the type of point summary, and the second name indicates the type of interval. `qi` yields a quantile interval (a.k.a. equi-tailed interval, central interval, or percentile interval) and `hdi` yields a highest (posterior) density interval. Custom point or interval functions can also be applied using the `point_interval()` function.
For example, we might extract the draws corresponding to the posterior distributions of the overall mean and standard deviation of observations:
```{r}
m %>%
spread_draws(`(Intercept)`, sigma) %>%
head(10)
```
Like with `b[term,group]`, this gives us a tidy data frame. If we want the median and 95% quantile interval of the variables, we can apply `median_qi()`:
```{r}
m %>%
spread_draws(`(Intercept)`, sigma) %>%
median_qi(`(Intercept)`, sigma)
```
We can specify the columns we want to get medians and intervals from, as above, or if we omit the list of columns, `median_qi()` will use every column that is not a grouping column or a special column (like `.chain`, `.iteration`, or `.draw`). Thus in the above example, `(Intercept)` and `sigma` are redundant arguments to `median_qi()` because they are also the only columns we gathered from the model. So we can simplify this to:
```{r}
m %>%
spread_draws(`(Intercept)`, sigma) %>%
median_qi()
```
If you would rather have a long-format list of intervals, use `gather_draws()` instead:
```{r}
m %>%
gather_draws(`(Intercept)`, sigma) %>%
median_qi()
```
For more on `gather_draws()`, see `vignette("tidybayes")`.
### With indexed variables
When we have a model variable with one or more indices, such as `b`, we can apply `median_qi()` (or other functions in the `point_interval()` family) as we did before:
```{r}
m %>%
spread_draws(b[,group]) %>%
median_qi()
```
How did `median_qi()` know what to aggregate? Data frames returned by `spread_draws()` are automatically grouped by all index variables you pass to it; in this case, that means `spread_draws()` groups its results by `group`. `median_qi()` respects those groups, and calculates the point summaries and intervals within all groups. Then, because no columns were passed to `median_qi()`, it acts on the only non-special (`.`-prefixed) and non-group column, `b`. So the above shortened syntax is equivalent to this more verbose call:
```{r}
m %>%
spread_draws(b[,group]) %>%
group_by(group) %>% # this line not necessary (done by spread_draws)
median_qi(b) # b is not necessary (it is the only non-group column)
```
## Combining variables with different indices in a single tidy format data frame
`spread_draws()` and `gather_draws()` support extracting variables that have different indices into the same data frame. Indices with the same name are automatically matched up, and values are duplicated as necessary to produce one row per all combination of levels of all indices. For example, we might want to calculate the mean within each condition (call this `condition_mean`). In this model, that mean is the intercept (`(Intercept)`) plus the effect for a given condition (`b`).
We can gather draws from `(Intercept)` and `b` together in a single data frame:
```{r}
m %>%
spread_draws(`(Intercept)`, b[,group]) %>%
head(10)
```
Within each draw, `(Intercept)` is repeated as necessary to correspond to every index of `b`. Thus, the `mutate` function from dplyr can be used to find their sum, `condition_mean` (which is the mean for each condition):
```{r}
m %>%
spread_draws(`(Intercept)`, b[,group]) %>%
mutate(condition_mean = `(Intercept)` + b) %>%
median_qi(condition_mean)
```
`median_qi()` uses tidy evaluation (see `vignette("tidy-evaluation", package = "rlang")`), so it can take column expressions, not just column names. Thus, we can simplify the above example by moving the calculation of `condition_mean` from `mutate` into `median_qi()`:
```{r}
m %>%
spread_draws(`(Intercept)`, b[,group]) %>%
median_qi(condition_mean = `(Intercept)` + b)
```
## Plotting points and intervals
Plotting point summaries and with one interval is straightforward using `ggdist::geom_pointinterval()`:
```{r fig.width = small_width, fig.height = tiny_height}
m %>%
spread_draws(`(Intercept)`, b[,group]) %>%
median_qi(condition_mean = `(Intercept)` + b) %>%
ggplot(aes(y = group, x = condition_mean, xmin = .lower, xmax = .upper)) +
geom_pointinterval()
```
## Intervals with multiple probability levels
`median_qi()` and its sister functions can also produce an arbitrary number of probability intervals by setting the `.width =` argument:
```{r}
m %>%
spread_draws(`(Intercept)`, b[,group]) %>%
median_qi(condition_mean = `(Intercept)` + b, .width = c(.95, .8, .5))
```
The results are in a tidy format: one row per group and uncertainty interval width (`.width`). This facilitates plotting. For example, assigning `-.width` to the `size` aesthetic will show all intervals, making thicker lines correspond to smaller intervals. The `ggdist::geom_pointinterval()` geom automatically sets the `size` aesthetic appropriately based on the `.width` columns in the data to produce plots of points with multiple probability levels:
```{r fig.width = small_width, fig.height = tiny_height}
m %>%
spread_draws(`(Intercept)`, b[,group]) %>%
median_qi(condition_mean = `(Intercept)` + b, .width = c(.95, .66)) %>%
ggplot(aes(y = group, x = condition_mean, xmin = .lower, xmax = .upper)) +
geom_pointinterval()
```
## Intervals with densities
To see the density along with the intervals, we can use `ggdist::stat_eye()` ("eye plots", which combine intervals with violin plots), or `ggdist::stat_halfeye()` (interval + density plots):
```{r fig.width = small_width, fig.height = tiny_height}
m %>%
spread_draws(`(Intercept)`, b[,group]) %>%
mutate(condition_mean = `(Intercept)` + b) %>%
ggplot(aes(y = group, x = condition_mean)) +
stat_halfeye()
```
Or say you want to annotate portions of the densities in color; the `fill` aesthetic can vary within a slab in all geoms and stats in the `ggdist::geom_slabinterval()` family, including `ggdist::stat_halfeye()`. For example, if you want to annotate a domain-specific region of practical equivalence (ROPE), you could do something like this:
```{r fig.width = small_width, fig.height = tiny_height}
m %>%
spread_draws(`(Intercept)`, b[,group]) %>%
mutate(condition_mean = `(Intercept)` + b) %>%
ggplot(aes(y = group, x = condition_mean, fill = stat(abs(x) < .8))) +
stat_halfeye() +
geom_vline(xintercept = c(-.8, .8), linetype = "dashed") +
scale_fill_manual(values = c("gray80", "skyblue"))
```
## Other visualizations of distributions: `stat_slabinterval`
There are a variety of additional stats for visualizing distributions in the `ggdist::geom_slabinterval()` family of stats and geoms:
<img src="slabinterval_family.png" width="700" alt="The slabinterval family of geoms and stats" />
See `vignette("slabinterval", package = "ggdist")` for an overview.
## Posterior fits
Rather than calculating conditional means manually as in the previous example, we could use `add_fitted_draws()`, which is analogous to `rstanarm::posterior_linpred()` (giving posterior draws from the model's linear predictor, in this case, posterior distributions of conditional means), but uses a tidy data format. We can combine it with `modelr::data_grid()` to first generate a grid describing the fits we want, then transform that grid into a long-format data frame of draws from posterior fits:
```{r}
ABC %>%
data_grid(condition) %>%
add_fitted_draws(m) %>%
head(10)
```
To plot this example, we'll also show the use of `ggdist::stat_pointinterval()` instead of `ggdist::geom_pointinterval()`, which summarizes draws into point summaries and intervals within ggplot:
```{r fig.width = tiny_width, fig.height = tiny_height}
ABC %>%
data_grid(condition) %>%
add_fitted_draws(m) %>%
ggplot(aes(x = .value, y = condition)) +
stat_pointinterval(.width = c(.66, .95))
```
## Quantile dotplots
Intervals are nice if the alpha level happens to line up with whatever decision you are trying to make, but getting a shape of the posterior is better (hence eye plots, above). On the other hand, making inferences from density plots is imprecise (estimating the area of one shape as a proportion of another is a hard perceptual task). Reasoning about probability in frequency formats is easier, motivating [quantile dotplots](https://github.com/mjskay/when-ish-is-my-bus/blob/master/quantile-dotplots.md) ([Kay et al. 2016](https://doi.org/10.1145/2858036.2858558), [Fernandes et al. 2018](https://doi.org/10.1145/3173574.3173718)), which also allow precise estimation of arbitrary intervals (down to the dot resolution of the plot, 100 in the example below).
Within the slabinterval family of geoms in tidybayes is the `dots` and `dotsinterval` family, which automatically determine appropriate bin sizes for dotplots and can calculate quantiles from samples to construct quantile dotplots. `ggdist::stat_dots()` is the horizontal variant designed for use on samples:
```{r fig.width = med_width, fig.height = med_height}
ABC %>%
data_grid(condition) %>%
add_fitted_draws(m) %>%
ggplot(aes(x = .value, y = condition)) +
stat_dots(quantiles = 100)
```
The idea is to get away from thinking about the posterior as indicating one canonical point or interval, but instead to represent it as (say) 100 approximately equally likely points.
## Posterior predictions
Where `add_fitted_draws()` is analogous to `rstanarm::posterior_linpred()`, `add_predicted_draws()` is analogous to `rstanarm::posterior_predict()`, giving draws from the posterior predictive distribution.
Here is an example of posterior predictive distributions plotted using `ggdist::stat_slab()`:
```{r fig.width = small_width, fig.height = tiny_height}
ABC %>%
data_grid(condition) %>%
add_predicted_draws(m) %>%
ggplot(aes(x = .prediction, y = condition)) +
stat_slab()
```
We could also use `tidybayes::stat_interval()` to plot predictive bands alongside the data:
```{r fig.width = small_width, fig.height = tiny_height}
ABC %>%
data_grid(condition) %>%
add_predicted_draws(m) %>%
ggplot(aes(y = condition, x = .prediction)) +
stat_interval() +
geom_point(aes(x = response), data = ABC) +
scale_color_brewer()
```
Altogether, data, posterior predictions, and posterior distributions of the means:
```{r fig.width = small_width, fig.height = small_height}
grid = ABC %>%
data_grid(condition)
fits = grid %>%
add_fitted_draws(m)
preds = grid %>%
add_predicted_draws(m)
ABC %>%
ggplot(aes(y = condition, x = response)) +
stat_interval(aes(x = .prediction), data = preds) +
stat_pointinterval(aes(x = .value), data = fits, .width = c(.66, .95), position = position_nudge(y = -0.3)) +
geom_point() +
scale_color_brewer()
```
## Fit/prediction curves
To demonstrate drawing fit curves with uncertainty, let's fit a slightly naive model to part of the `mtcars` dataset:
```{r m_mpg_stan_glm, results = "hide", message = FALSE, warning = FALSE, cache = TRUE}
m_mpg = stan_glm(mpg ~ hp * cyl, data = mtcars)
```
We can plot fit curves with probability bands:
```{r fig.width = med_width, fig.height = small_height}
mtcars %>%
group_by(cyl) %>%
data_grid(hp = seq_range(hp, n = 51)) %>%
add_fitted_draws(m_mpg) %>%
ggplot(aes(x = hp, y = mpg, color = ordered(cyl))) +
stat_lineribbon(aes(y = .value)) +
geom_point(data = mtcars) +
scale_fill_brewer(palette = "Greys") +
scale_color_brewer(palette = "Set2")
```
Or we can sample a reasonable number of fit lines (say 100) and overplot them:
```{r fig.width = med_width, fig.height = small_height}
mtcars %>%
group_by(cyl) %>%
data_grid(hp = seq_range(hp, n = 101)) %>%
add_fitted_draws(m_mpg, n = 100) %>%
ggplot(aes(x = hp, y = mpg, color = ordered(cyl))) +
geom_line(aes(y = .value, group = paste(cyl, .draw)), alpha = .1) +
geom_point(data = mtcars) +
scale_color_brewer(palette = "Dark2")
```
Or we can create animated [hypothetical outcome plots (HOPs)](https://mucollective.northwestern.edu/project/hops-trends) of fit lines:
```{r}
set.seed(123456)
ndraws = 50
p = mtcars %>%
group_by(cyl) %>%
data_grid(hp = seq_range(hp, n = 101)) %>%
add_fitted_draws(m_mpg, n = ndraws) %>%
ggplot(aes(x = hp, y = mpg, color = ordered(cyl))) +
geom_line(aes(y = .value, group = paste(cyl, .draw))) +
geom_point(data = mtcars) +
scale_color_brewer(palette = "Dark2") +
transition_states(.draw, 0, 1) +
shadow_mark(future = TRUE, color = "gray50", alpha = 1/20)
animate(p, nframes = ndraws, fps = 2.5, width = 432, height = 288, res = 96, dev = "png", type = "cairo")
```
Or, for posterior predictions (instead of fits), we can go back to probability bands:
```{r fig.width = med_width, fig.height = small_height}
mtcars %>%
group_by(cyl) %>%
data_grid(hp = seq_range(hp, n = 101)) %>%
add_predicted_draws(m_mpg) %>%
ggplot(aes(x = hp, y = mpg, color = ordered(cyl), fill = ordered(cyl))) +
stat_lineribbon(aes(y = .prediction), .width = c(.95, .80, .50), alpha = 1/4) +
geom_point(data = mtcars) +
scale_fill_brewer(palette = "Set2") +
scale_color_brewer(palette = "Dark2")
```
This can get difficult to judge by group, so could be better to facet into multiple plots. Fortunately, since we are using ggplot, that functionality is built in:
```{r fig.width = med_width, fig.height = small_height}
mtcars %>%
group_by(cyl) %>%
data_grid(hp = seq_range(hp, n = 101)) %>%
add_predicted_draws(m_mpg) %>%
ggplot(aes(x = hp, y = mpg)) +
stat_lineribbon(aes(y = .prediction), .width = c(.99, .95, .8, .5), color = brewer.pal(5, "Blues")[[5]]) +
geom_point(data = mtcars) +
scale_fill_brewer() +
facet_grid(. ~ cyl, space = "free_x", scales = "free_x")
```
## Comparing levels of a factor
If we wish compare the means from each condition, `compare_levels()` facilitates comparisons of the value of some variable across levels of a factor. By default it computes all pairwise differences.
Let's demonstrate `compare_levels()` with `ggdist::stat_halfeye()`:
```{r fig.width = small_width, fig.height = small_height}
#N.B. the syntax for compare_levels is experimental and may change
m %>%
spread_draws(b[,,condition], sep = "[, :]") %>%
compare_levels(b, by = condition) %>%
ggplot(aes(y = condition, x = b)) +
stat_halfeye()
```
If you prefer "caterpillar" plots, ordered by something like the mean of the difference, you can reorder the factor before plotting:
```{r fig.width = small_width, fig.height = small_height}
#N.B. the syntax for compare_levels is experimental and may change
m %>%
spread_draws(b[,,condition], sep = "[, :]") %>%
compare_levels(b, by = condition) %>%
ungroup() %>%
mutate(condition = reorder(condition, b)) %>%
ggplot(aes(y = condition, x = b)) +
stat_halfeye() +
geom_vline(xintercept = 0, linetype = "dashed")
```
## Ordinal models
### Ordinal model with categorical predictor
Here's an ordinal model with a categorical predictor:
```{r m_esoph_rs_stan_polr, cache = TRUE}
data(esoph)
m_esoph_rs = stan_polr(tobgp ~ agegp, data = esoph, prior = R2(0.25), prior_counts = rstanarm::dirichlet(1))
```
The `rstanarm::posterior_linpred()` function for ordinal regression models in rstanarm returns only the link-level prediction for each draw (in contrast to `brms::fitted.brmsfit()`, which returns one prediction per category for ordinal models, see the ordinal regression examples in `vignette("tidy-brms")`). The philosophy of `tidybayes` is to tidy whatever format is output by a model, so in keeping with that philosophy, when applied to ordinal `rstanarm` models, `add_fitted_draws()` just returns the link-level prediction (**Note**: setting `scale = "response"` for such models will not usually make sense).
For example, here is a plot of the link-level fit:
```{r fig.width = small_width, fig.height = tiny_height}
esoph %>%
data_grid(agegp) %>%
add_fitted_draws(m_esoph_rs, scale = "linear") %>%
ggplot(aes(x = as.numeric(agegp), y = .value)) +
stat_lineribbon(color = "red") +
scale_fill_brewer(palette = "Greys")
```
This can be hard to interpret. To turn this into predicted probabilities on a per-category basis, we have to use the fact that an ordinal logistic regression defines the probability of an outcome in category $j$ **or less** as:
$$
\textrm{logit}\left[Pr(Y\le j)\right] = \alpha_j - \beta x
$$
Thus, the probability of category $j$ is:
$$
\begin{align}
Pr(Y = j) &= Pr(Y \le j) - Pr(Y \le j - 1)\\
&= \textrm{logit}^{-1}(\alpha_j - \beta x) - \textrm{logit}^{-1}(\alpha_{j-1} - \beta x)
\end{align}
$$
To derive these values, we need two things:
- The $\alpha_j$ values. These are threshold parameters fitted by the model. For convenience, if there are $k$ levels, we will take $\alpha_k = +\infty$, since the probability of being in the top level or below it is 1.
- The $\beta x$ values. These are just the `.value` column returned by `add_fitted_draws()`.
The thresholds in `rstanarm` are coefficients with names containing `|`, indicating which categories they are thresholds between. We can see those parameters in the list of variables in the model:
```{r}
get_variables(m_esoph_rs)
```
We can extract those automatically by using the `regex = TRUE` argument to `gather_draws()` to find all variables containing a `|` character. We will then use `dplyr::summarise_all(list)` to turn these thresholds into a list column, and add a final threshold equal to $+\infty$ (to represent the highest category):
```{r}
thresholds = m_esoph_rs %>%
gather_draws(`.*[|].*`, regex = TRUE) %>%
group_by(.draw) %>%
select(.draw, threshold = .value) %>%
summarise_all(list) %>%
mutate(threshold = map(threshold, ~ c(., Inf)))
head(thresholds, 10)
```
For example, the threshold vector from one row of this data frame (i.e., from one draw from the posterior) looks like this:
```{r}
thresholds[1,]$threshold
```
We can combine those thresholds (the $\alpha_j$ values from the above formula) with the `.value` from `add_fitted_draws()` ($\beta x$ from the above formula) to calculate per-category probabilities:
```{r fig.width = med_width, fig.height = med_height}
esoph %>%
data_grid(agegp) %>%
add_fitted_draws(m_esoph_rs, scale = "linear") %>%
inner_join(thresholds, by = ".draw") %>%
mutate(`P(Y = category)` = map2(threshold, .value, function(alpha, beta_x)
# this part is logit^-1(alpha_j - beta*x) - logit^-1(alpha_j-1 - beta*x)
plogis(alpha - beta_x) -
plogis(lag(alpha, default = -Inf) - beta_x)
)) %>%
mutate(.category = list(levels(esoph$tobgp))) %>%
unnest(c(threshold, `P(Y = category)`, .category)) %>%
ggplot(aes(x = agegp, y = `P(Y = category)`, color = .category)) +
stat_pointinterval(position = position_dodge(width = .4)) +
scale_size_continuous(guide = FALSE) +
scale_color_manual(values = brewer.pal(6, "Blues")[-c(1,2)])
```
It is hard to see the changes in categories in the above plot; let's try something that gives a better gist of the distribution within each year:
```{r fig.width = large_width, fig.height = large_height/2}
esoph_plot = esoph %>%
data_grid(agegp) %>%
add_fitted_draws(m_esoph_rs, scale = "linear") %>%
inner_join(thresholds, by = ".draw") %>%
mutate(`P(Y = category)` = map2(threshold, .value, function(alpha, beta_x)
# this part is logit^-1(alpha_j - beta*x) - logit^-1(alpha_j-1 - beta*x)
plogis(alpha - beta_x) -
plogis(lag(alpha, default = -Inf) - beta_x)
)) %>%
mutate(.category = list(levels(esoph$tobgp))) %>%
unnest(c(threshold, `P(Y = category)`, .category)) %>%
ggplot(aes(x = `P(Y = category)`, y = .category)) +
coord_cartesian(expand = FALSE) +
facet_grid(. ~ agegp, switch = "x") +
theme_classic() +
theme(strip.background = element_blank(), strip.placement = "outside") +
ggtitle("P(tobacco consumption category | age group)") +
xlab("age group")
esoph_plot +
stat_summary(fun = median, geom = "bar", fill = "gray75", width = 1, color = "white") +
stat_pointinterval()
```
The bars in this case might present a false sense of precision, so we could also try CCDF barplots instead:
```{r fig.width = large_width, fig.height = large_height/2}
esoph_plot +
stat_ccdfinterval() +
expand_limits(x = 0) #ensure bars go to 0
```
This output should be very similar to the output from the corresponding `m_esoph_brm` model in `vignette("tidy-brms")` (modulo different priors), though it takes a bit more work to produce in `rstanarm` compared to `brms`.