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
|
#' Default **bayesplot** plotting theme
#'
#' The [theme_default()] function returns the default ggplot
#' [theme][ggplot2::theme] used by the **bayesplot** plotting functions. See
#' [bayesplot_theme_set()] for details on setting and updating the plotting
#' theme.
#'
#' @export
#' @param base_size,base_family Base font size and family (passed to
#' [ggplot2::theme_bw()]). It is possible to set `"bayesplot.base_size"` and
#' `"bayesplot.base_family"` via [options()] to change the defaults, which are
#' `12` and `"serif"`, respectively.
#' @return A ggplot [theme][ggplot2::theme] object.
#'
#' @seealso [bayesplot_theme_set()] to change the ggplot theme.
#' @template seealso-colors
#' @template seealso-helpers
#'
#' @examples
#' class(theme_default())
#'
#' bayesplot_theme_set() # defaults to setting theme_default()
#' x <- example_mcmc_draws()
#' mcmc_hist(x)
#'
#' # change the default font size and family for bayesplots
#' bayesplot_theme_set(theme_default(base_size = 8, base_family = "sans"))
#' mcmc_hist(x)
#' mcmc_areas(x, regex_pars = "beta")
#'
#' # change back
#' bayesplot_theme_set()
#' mcmc_areas(x, regex_pars = "beta")
#'
theme_default <-
function(base_size = getOption("bayesplot.base_size", 12),
base_family = getOption("bayesplot.base_family", "serif")) {
theme_bw(
base_family = base_family,
base_size = base_size
) +
theme(
plot.background = element_blank(),
panel.grid = element_blank(),
panel.background = element_blank(),
panel.border = element_blank(),
axis.line = element_line(linewidth = 0.4),
axis.ticks = element_line(linewidth = 0.3),
strip.background = element_blank(),
strip.text = element_text(size = rel(0.9)),
strip.placement = "outside",
# strip.background = element_rect(fill = "gray95", color = NA),
panel.spacing = unit(1.5, "lines"),
legend.position = "right",
legend.background = element_blank(),
legend.text = element_text(size = 13, hjust = 0),
legend.key = element_blank()
)
}
#' Get, set, and modify the active **bayesplot** theme
#'
#' @description These functions are the **bayesplot** equivalent to
#' **ggplot2**'s [ggplot2::theme_set()] and friends. They set, get, and update
#' the active theme but only apply them to `bayesplots`. The current/active
#' theme is automatically applied to every `bayesplot` you draw.
#'
#' Use `bayesplot_theme_get()` to get the current **bayesplot** theme and
#' `bayesplot_theme_set()` to set a new theme. `bayesplot_theme_update()` and
#' `bayesplot_theme_replace()` are shorthands for changing individual elements.
#'
#' @details `bayesplot_theme_set()` and friends only apply to `bayesplots`.
#' However, [ggplot2::theme_set()] can also be used to change the
#' **bayesplot** theme. Currently, setting a theme with `ggplot2::theme_set()`
#' (other than the **ggplot2** default [ggplot2::theme_grey()]) will override
#' the **bayesplot** theme.
#'
#' @export
#' @param new The new theme (list of theme elements) to use. This is analogous
#' to the `new` argument to [ggplot2::theme_set()].
#' @param ... A named list of theme settings.
#'
#' @return `bayesplot_theme_get()` returns the current theme. The other three
#' functions (set, update, replace) invisibly return the *previous* theme
#' so it can be saved and easily restored later. This is the same behavior as
#' the **ggplot2** versions of these functions.
#'
#' @seealso [theme_default()] for the default **bayesplot** theme.
#' @template seealso-helpers
#' @template seealso-colors
#'
#' @examples
#' library(ggplot2)
#'
#' # plot using the current value of bayesplot_theme_get()
#' # (the default is bayesplot::theme_default())
#' x <- example_mcmc_draws()
#' mcmc_hist(x)
#'
#' # change the bayesplot theme to theme_minimal and save the old theme
#' old <- bayesplot_theme_set(theme_minimal())
#' mcmc_hist(x)
#'
#' # change back to the previous theme
#' bayesplot_theme_set(old)
#' mcmc_hist(x)
#'
#' # change the default font size and family for bayesplots
#' bayesplot_theme_update(text = element_text(size = 16, family = "sans"))
#' mcmc_hist(x)
#'
#' # change back to the default
#' bayesplot_theme_set() # same as bayesplot_theme_set(theme_default())
#' mcmc_hist(x)
#'
#' # updating theme elements
#' color_scheme_set("brightblue")
#' bayesplot_theme_set(theme_dark())
#' mcmc_hist(x)
#'
#' bayesplot_theme_update(panel.background = element_rect(fill = "black"))
#' mcmc_hist(x)
#'
#' # to get the same plot without updating the theme we could also have
#' # used the bayeplot convenience function panel_bg()
#' bayesplot_theme_set(theme_dark())
#' mcmc_hist(x) + panel_bg(fill = "black")
#'
#' # reset
#' bayesplot_theme_set()
#'
bayesplot_theme_get <- function() {
if (!identical(.bayesplot_theme_env$gg_current, ggplot2::theme_get())) {
.bayesplot_theme_env$current <- ggplot2::theme_get()
.bayesplot_theme_env$gg_current <- ggplot2::theme_get()
thm <- .bayesplot_theme_env$gg_current
} else {
thm <- .bayesplot_theme_env$current
}
thm
}
#' @rdname bayesplot_theme_get
#' @export
bayesplot_theme_set <- function(new = theme_default()) {
missing <- setdiff(names(ggplot2::theme_gray()), names(new))
if (length(missing)) {
warn(paste(
"New theme missing the following elements:",
paste(missing, collapse = ", ")
))
}
old <- .bayesplot_theme_env$current
.bayesplot_theme_env$current <- new
.bayesplot_theme_env$gg_current <- ggplot2::theme_get()
invisible(old)
}
#' @rdname bayesplot_theme_get
#' @export
bayesplot_theme_update <- function(...) {
bayesplot_theme_set(bayesplot_theme_get() + ggplot2::theme(...))
}
#' @rdname bayesplot_theme_get
#' @export
#' @importFrom ggplot2 %+replace%
bayesplot_theme_replace <- function(...) {
bayesplot_theme_set(bayesplot_theme_get() %+replace% ggplot2::theme(...))
}
# internal ----------------------------------------------------------------
.bayesplot_theme_env <- new.env(parent = emptyenv())
.bayesplot_theme_env$current <- theme_default()
.bayesplot_theme_env$gg_current <- ggplot2::theme_grey()
|
