R/themes.R

In kbrevoort/kpbtemplates: Kenneth P. Brevoort's Templates

#' Presentation Theme
#'
#' This is a ggplot2 theme that I have prepared to format graphs in my
#' preferred style for presentations, which uses larger fonts than would
#' be appropriate in a printed graph.
#' @importFrom ggplot2 theme theme_minimal margin element_text element_line element_blank
#' @export
theme_presentation <- function(y.ontop = FALSE,
                               legend.position = 'none',
                               as.ts = FALSE,
                               plot.margin = margin(0, 0, 0, 0),
                               panel.grid.major.x = element_blank(),
                               panel.grid.minor.x = element_blank(),
                               panel.grid.major.y = element_blank(),
                               panel.grid.minor.y = element_blank()) {

  if (as.ts) {
    # Switch the major and minor grid lines so that the heavier weight lines
    # correspond to the start and end of each year
    temp <- panel.grid.minor.x
    panel.grid.minor.x <- panel.grid.major.x
    panel.grid.major.x <- temp
  }

  this_title <- ggtext::element_textbox_simple(family = 'sans',
                                               size = 12L,
                                               lineheight = 1,
                                               hjust = 0,
                                               vjust = 0.5,
                                               face = 'bold')

  if (y.ontop) {
    this_subtitle <- ggtext::element_textbox_simple(family = 'sans',
                                                    face = 'italic',
                                                    size = 12,
                                                    hjust = 0,
                                                    vjust = 0.5)
    this_y_title <- element_blank()
  } else {
    this_subtitle <- ggtext::element_textbox_simple(family = 'sans',
                                                    face = 'plain',
                                                    size = 14,
                                                    hjust = 0,
                                                    vjust = 0.5)
    this_y_title <- element_text(family = 'sans',
                                 face = 'italic',
                                 angle = 90,
                                 size = 12,
                                 hjust = 0.5,
                                 vjust = 0.5,
                                 margin = margin(b = 5, l = 0, t = 0, r = 0))
  }


  t <- theme(
    plot.margin = plot.margin,
    plot.title.position = 'plot',
    plot.title = this_title,
    plot.subtitle = this_subtitle,
    axis.title.y = this_y_title,
    # plot.title = element_text(size = 18L,
    #                           lineheight = 1,
    #                           hjust = 0,
    #                           vjust = 0.5,
    #                           family = 'sans',
    #                           face = 'bold',
    #                           margin = margin(b = 10, l = 0, t = 10, r = 0)),
    # plot.subtitle = element_text(size = 14L,
    #                              lineheight = 1,
    #                              hjust = 0,
    #                              vjust = 0.5,
    #                              family = 'sans',
    #                              face = 'plain',
    #                              margin = margin(b = 10, l = 0, t = 0, r = 0)),
    # axis.title.y = element_text(family = 'sans',
    #                             face = 'italic',
    #                             angle = 90,
    #                             size = 12L,
    #                             hjust = 0.5,
    #                             vjust = 0.5,
    #                             margin = margin(b = 5, l = 0, t = 0, r = 0)),
    axis.title.x = element_text(family = 'sans',
                                face = 'italic',
                                angle = 0,
                                size = 12L,
                                hjust = 0.5,
                                vjust = 0.5,
                                margin = margin(b = 10, l = 0, t = 10, r = 0)),
    axis.text.y = element_text(family = 'sans',
                               size = 12L,
                               hjust = 1,
                               vjust = 0.5,
                               face = 'plain'),
    axis.text.x = element_text(family = 'sans',
                               size = 12L,
                               hjust = 0.5,
                               vjust = 0.5,
                               face = 'plain'),
    #axis.line = element_blank(),
    axis.line = element_line(color = 'black',
                               size = 1L,
                               linetype = 'solid',
                               inherit.blank = FALSE),
    axis.line.y = element_blank(),
    axis.ticks = element_blank(),
    strip.text = element_text(family = 'sans',
                              size = 12L,
                              hjust = 0.5,
                              vjust = 0.5,
                              face = 'bold'),
    plot.tag.position = c(1, 1),
    plot.tag = element_text(family = 'serif',
                            face = 'bold',
                            size = 14L,
                            lineheight = 2,
                            hjust = 1,
                            vjust = 0.5,
                            margin = margin(b = 5, t = 5, r = 0, l = 0)),
    plot.caption.position = 'plot',
    plot.caption = element_text(family = 'serif',
                                face = 'plain',
                                size = 11L,
                                lineheight = 1.3,
                                hjust = 0,
                                vjust = 0.5,
                                margin = margin(b = 10, l = 0, t = 10, r = 0)),
    legend.position = legend.position,
    legend.title = element_blank(),
    complete = TRUE
  )

  theme_minimal() %+replace% t
}

#' Presentation Theme
#'
#' This is a ggplot2 theme that I have prepared to format graphs in my
#' preferred style for presentations, which uses larger fonts than would
#' be appropriate in a printed graph.
#' @importFrom ggplot2 theme theme_minimal margin element_text element_line element_blank
#' @export
theme_print <- function(y.ontop = FALSE,
                        legend.position = 'none',
                        as.ts = FALSE,
                        plot.margin = margin(0, 0, 0, 0),
                        panel.grid.major.x = element_blank(),
                        panel.grid.minor.x = element_blank(),
                        panel.grid.major.y = element_blank(),
                        panel.grid.minor.y = element_blank()) {

  if (as.ts) {
    # Switch the major and minor grid lines so that the heavier weight lines
    # correspond to the start and end of each year
    temp <- panel.grid.minor.x
    panel.grid.minor.x <- panel.grid.major.x
    panel.grid.major.x <- temp
  }

  this_title <- ggtext::element_textbox_simple(family = 'sans',
                                               size = 12L,
                                               lineheight = 1,
                                               hjust = 0,
                                               vjust = 0.5,
                                               face = 'bold')

  if (y.ontop) {
    this_subtitle <- ggtext::element_textbox_simple(family = 'sans',
                                                    face = 'italic',
                                                    size = 8.5,
                                                    hjust = 0,
                                                    vjust = 0.5)
    this_y_title <- element_blank()
  } else {
    this_subtitle <- ggtext::element_textbox_simple(family = 'sans',
                                                    face = 'plain',
                                                    size = 9.5,
                                                    hjust = 0,
                                                    vjust = 0.5)
    this_y_title <- element_text(family = 'sans',
                                 face = 'italic',
                                 angle = 90,
                                 size = 8.5,
                                 hjust = 0.5,
                                 vjust = 0.5,
                                 margin = margin(b = 5, l = 0, t = 0, r = 0))
  }

  t <- theme(
    plot.margin = plot.margin,
    plot.title.position = 'plot',
    plot.title = this_title,
    plot.subtitle = this_subtitle,
    axis.title.y = this_y_title,
    # plot.title = element_text(size = 12L,
    #                           lineheight = 1,
    #                           hjust = 0,
    #                           vjust = 0.5,
    #                           family = 'sans',
    #                           face = 'bold',
    #                           margin = margin(b = 10, l = 0, t = 10, r = 0)),
    # plot.subtitle = element_text(size = 9.5,
    #                              lineheight = 1,
    #                              hjust = 0,
    #                              vjust = 0.5,
    #                              family = 'sans',
    #                              face = 'plain',
    #                              margin = margin(b = 10, l = 0, t = 0, r = 0)),
    # axis.title.y = element_text(family = 'sans',
    #                             face = 'italic',
    #                             angle = 90,
    #                             size = 8.5,
    #                             hjust = 0.5,
    #                             vjust = 0.5,
    #                             margin = margin(b = 5, l = 0, t = 0, r = 0)),
    axis.title.x = element_text(family = 'sans',
                                face = 'italic',
                                angle = 0,
                                size = 8.5,
                                hjust = 0.5,
                                vjust = 0.5,
                                margin = margin(b = 10, l = 0, t = 10, r = 0)),
    axis.text.y = element_text(family = 'sans',
                               size = 8.5,
                               hjust = 1,
                               vjust = 0.5,
                               face = 'plain'),
    axis.text.x = element_text(family = 'sans',
                               size = 8.5,
                               hjust = 0.5,
                               vjust = 0.5,
                               face = 'plain'),
    axis.line = element_line(color = 'black',
                               size = 1L,
                               linetype = 'solid',
                             inherit.blank = FALSE),
    axis.line.y = element_blank(),
    axis.ticks = element_blank(),
    strip.text = element_text(family = 'sans',
                              size = 8.5,
                              hjust = 0.5,
                              vjust = 0.5,
                              face = 'bold'),
    panel.grid.major.x = panel.grid.major.x,
    panel.grid.minor.x = panel.grid.minor.x,
    panel.grid.major.y = panel.grid.major.y,
    panel.grid.minor.y = panel.grid.minor.y,
    plot.tag.position = c(1, 1),
    plot.tag = element_text(family = 'serif',
                            face = 'bold',
                            size = 12L,
                            lineheight = 2,
                            hjust = 1,
                            vjust = 0.5,
                            margin = margin(b = 5, t = 5, r = 0, l = 0)),
    plot.caption.position = 'plot',
    plot.caption = element_text(family = 'serif',
                                face = 'plain',
                                size = 8L,
                                lineheight = 1.3,
                                hjust = 0,
                                vjust = 0.5,
                                margin = margin(b = 10, l = 0, t = 10, r = 0)),
    legend.position = legend.position,
    legend.title = element_blank(),
    complete = TRUE
  )

  theme_minimal() %+replace% t
}

#' @export
theme_quarto_notes <- function(...) {

  t <- theme(
    plot.title = ggtext::element_textbox_simple(size = 11L,
                                                face = 'plain',
                                                family = 'serif',
                                                padding = margin(t = 10,
                                                                 b = 20)))
  theme_print(...) %+replace% t
}

#' @export
theme_timeseries <- function(legend.position = 'none',
                             plot.margin = margin(0, 0, 0, 0),
                             panel.grid.major.x = element_line(size = rel(1L),
                                                               color = 'gray',
                                                               inherit.blank = FALSE),
                             panel.grid.minor.x = element_line(size = rel(0.5),
                                                               color = 'gray',
                                                               inherit.blank = TRUE)) {

  t <- theme(
    # Switch the major and minor grid lines so that the heavier weight lines
    # correspond to the start and end of each year
    panel.grid.major.x = panel.grid.minor.x,
    panel.grid.minor.x = panel.grid.major.x,
    panel.grid.minor.y = element_blank()
  )

  theme_presentation(legend.position = legend.position, plot.margin = plot.margin) %+replace% t
}