ggplot2 (version 4.0.1)

get_theme: Get, set, and modify the active theme

Description

The current/active theme (see theme()) is automatically applied to every plot you draw. Use get_theme() to get the current theme, and set_theme() to completely override it. update_theme() and replace_theme() are shorthands for changing individual elements.

Usage

get_theme()
theme_get()
set_theme(new = NULL)
theme_set(new = NULL)
update_theme(...)
theme_update(...)
replace_theme(...)
theme_replace(...)
e1 %+replace% e2

Value

set_theme(), update_theme(), and replace_theme()

invisibly return the previous theme so you can easily save it, then later restore it.

Arguments

new

new theme (a list of theme elements). Sets theme to the default (theme_grey()) if new isn't supplied.

...

named list of theme settings

e1, e2

Theme and element to combine

Adding on to a theme

+ and %+replace% can be used to modify elements in themes.

+ updates the elements of e1 that differ from elements specified (not NULL) in e2. Thus this operator can be used to incrementally add or modify attributes of a ggplot theme.

In contrast, %+replace% replaces the entire element; any element of a theme not specified in e2 will not be present in the resulting theme (i.e. NULL). Thus this operator can be used to overwrite an entire theme.

update_theme() uses the + operator, so that any unspecified values in the theme element will default to the values they are set in the theme. replace_theme() uses %+replace% to completely replace the element, so any unspecified values will overwrite the current value in the theme with NULL.

In summary, the main differences between set_theme(), update_theme(), and replace_theme() are:

• set_theme() completely overrides the current theme.

• update_theme() modifies a particular element of the current theme using the + operator.

• replace_theme() modifies a particular element of the current theme using the %+replace% operator.

See Also

add_gg()

Examples

p <- ggplot(mtcars, aes(mpg, wt)) +
  geom_point()
p

# Use set_theme() to completely override the current theme.
# update_theme() and replace_theme() are similar except they
# apply directly to the current/active theme.
# update_theme() modifies a particular element of the current theme.
# Here we have the old theme so we can later restore it.
# Note that the theme is applied when the plot is drawn, not
# when it is created.
old <- set_theme(theme_bw())
p

set_theme(old)
update_theme(panel.grid.minor = element_line(colour = "red"))
p

set_theme(old)
replace_theme(panel.grid.minor = element_line(colour = "red"))
p

set_theme(old)
p


# Modifying theme objects -----------------------------------------
# You can use + and %+replace% to modify a theme object.
# They differ in how they deal with missing arguments in
# the theme elements.

add_el <- theme_grey() +
  theme(text = element_text(family = "Times"))
add_el$text

rep_el <- theme_grey() %+replace%
  theme(text = element_text(family = "Times"))
rep_el$text