tinytheme: Set or Reset Plot Themes for `tinyplot`

Description

The tinytheme function sets or resets the theme for plots created with tinyplot. Themes control the appearance of plots, such as text alignment, font styles, axis labels, and even dynamic margin adjustment to reduce whitespace.

Usage

tinytheme(
  theme = c("default", "basic", "clean", "clean2", "bw", "classic", "minimal", "ipsum",
    "dark", "ridge", "ridge2", "tufte", "void"),
  ...
)

Value

The function returns nothing. It is called for its side effects.

Arguments

theme

A character string specifying the name of the theme to apply. Themes are arranged in an approximate hierarchy, adding or subtracting elements in the order presented below. Note that several themes are dynamic, in the sense that they attempt to reduce whitespace in a way that is responsive to the length of axes labels, tick marks, etc. These dynamic plots are marked with an asterisk (*) below.

"default": inherits the user's default base graphics settings.
"basic": light modification of "default", only adding filled points, a panel background grid, and light gray background to facet titles.
"clean" (*): builds on "basic" by moving the subtitle above the plotting area, adding horizontal axis labels, employing tighter default plot margins and title gaps to reduce whitespace, and setting different default palettes ("Tableau 10" for discrete colors and "agSunset" for gradient colors). The first of our dynamic themes and the foundation for several derivative themes that follow below.
"clean2" (*): removes the plot frame (box) from "clean".
"classic" (*): connects the axes in a L-shape, but removes the other top and right-hand edges of the plot frame (box). Also sets the "Okabe-Ito" palette as a default for discrete colors. Inspired by the ggplot2 theme of the same name.
"bw" (*): similar to "clean", except uses thinner lines for the plot frame (box), solid grid lines, and sets the "Okabe-Ito" palette as a default for discrete colors. Inspired by the ggplot2 theme of the same name.
"minimal" (*): removes the plot frame (box) from "bw", as well as the background for facet titles. Inspired by the ggplot2 theme of the same name.
"ipsum" (*): similar to "minimal", except subtitle is italicised and axes titles are aligned to the far edges. Inspired by the hrbrthemes theme of the same name for ggplot2.
"dark" (*): similar to "minimal", but set against a dark background with foreground and a palette colours lightened for appropriate contrast.
"ridge" (*): a specialized theme for ridge plots (see type_ridge()). Builds off of "clean", but adds ridge-specific tweaks (e.g. default "Zissou 1" palette for discrete colors, solid horizontal grid lines, and minor adjustments to y-axis labels). Not recommended for non-ridge plots.
"ridge2" (*): removes the plot frame (box) from "ridge", but retains the x-axis line. Again, not recommended for non-ridge plots.
"tufte": floating axes and minimalist plot artifacts in the style of Edward Tufte.
"void": switches off all axes, titles, legends, etc.

...

Named arguments to override specific theme settings. These arguments are passed to tpar() and take precedence over the predefined settings in the selected theme.

Details

Sets a list of graphical parameters using tpar()

Note that themes are persistent and will be applied to all subsequent plots. To reset the theme to default settings (no customization), call tinytheme() without arguments. Altenatively, invoke the tinyplot(..., theme = <theme>) argument for an ephemeral theme that is automatically reset at the end of the plot call.

Caveat emptor: Themes are a somewhat experimental feature of tinyplot. While we feel confident that themes should work as expected for most "standard" cases, there may be some sharp edges. Please report any unexpected behaviour to our GitHub repo: https://github.com/grantmcdermott/tinyplot/issues

Known current limitations include:

Themes do not work well when legend = "top!".
Dynamic margin spacing does not account for multi-line strings (e.g., axes or main titles that contain "\n").

Examples

Run this code

# Reusable plot function
p = function() tinyplot(
  lat ~ long | depth, data = quakes,
  main = "Earthquakes off Fiji",
  sub = "Data courtesy of the Harvard PRIM-H project"
)
p()

# Set a theme
tinytheme("bw")
p()

#  A set theme is persistent and will apply to subsequent plots
tinyplot(0:10)

# Try a different theme
tinytheme("dark")
p()
         
# Customize the theme by overriding default settings
tinytheme("bw", fg = "green", font.main = 2, font.sub = 3, family = "Palatino")
p()

# Another custom theme example
tinytheme("bw", font.main = 2, col.axis = "darkcyan", family = "HersheyScript")
p()

# Aside: One or two specialized themes are only meant for certain plot types
tinytheme("ridge2")
tinyplot(I(cut(lat, 10)) ~ depth, data = quakes, type = "ridge")

# Reset the theme
tinytheme()
p()

# For an ephemeral theme, use `tinyplot(..., theme = )` directly
tinyplot(0:10, theme = "clean", main = "This theme is ephemeral")
tinyplot(10:0, main = "See, no more theme")

# Themes showcase
## We'll use a slightly more intricate plot (long y-axis labs and facets)
## to demonstrate dynamic margin adjustment etc.

thms = eval(formals(tinytheme)$theme)

for (thm in thms) {
  tinytheme(thm)
  tinyplot(
    I(Sepal.Length*1e4) ~ Petal.Length | Species, facet = "by", data = iris,
    yaxl = ",", 
    main = paste0('tinytheme("', thm, '")'),
    sub = "A subtitle"
  )
  box("outer", lty = 2)
}

# Reset
tinytheme()