R/theme_TPL_print.R

In connorrothschild/tpltheme: Creates custom ggplot themes in the style of Texas Policy Lab

#' A print [ggplot2] theme formatted in TPL style
#'
#' \code{theme_tpl} provides a [ggplot2] theme formatted according to the TPL
#' website
#'
#' @import extrafont
#' @import ggrepel
#' @md
#' @param base_family base font family
#' @param base_size base font size
#' @param base_line_size base line
#' @param base_rect_size rectangle sizes
#' @export
theme_tpl_print <- function(base_size = 11,
                            base_family = 'Arial',
                            base_line_size = 0.5,
                            base_rect_size = 0.5) {
  half_line <- base_size / 2L

  ggplot2::theme(
    # main attributes

    line = ggplot2::element_line(
      colour = "#000000",
      size = base_line_size,
      linetype = 1L,
      lineend = "butt"
    ),
    rect = ggplot2::element_rect(
      fill = "#FFFFFF",
      colour = "#000000",
      size = base_rect_size,
      linetype = 1L
    ),
    text = ggplot2::element_text(
      family = base_family,
      face = "plain",
      colour = "#000000",
      size = base_size,
      hjust = 0.5,
      vjust = 0.5,
      angle = 0,
      lineheight = 0.9,
      margin = ggplot2::margin(),
      debug = FALSE
    ),

    # Plot Attributes

    plot.tag = ggplot2::element_text(
      size = base_size * 1.5,
      hjust = 0L,
      vjust = 0L,
      face = "bold",
      margin = ggplot2::margin(b = 10L)
    ),
    plot.tag.position = "topleft",
    plot.title = ggplot2::element_text(
      size = base_size * 12 / 8.5,
      hjust = 0L,
      vjust = 0L,
      face = "bold",
      margin = ggplot2::margin(b = 10L)
    ),
    plot.subtitle = ggplot2::element_text(
      size = base_size * 9.5 / 8.5,
      hjust = 0L,
      vjust = 1L,
      margin = ggplot2::margin(b = 10L)
    ),
    plot.caption = ggplot2::element_text(
      size = base_size * 7 / 8.5,
      hjust = 1L,
      vjust = 1L,
      margin = ggplot2::margin(t = half_line * 0.9)
    ),
    plot.background = NULL,

    plot.margin = ggplot2::margin(
      t = half_line,
      r = base_line_size * 24,
      b = half_line,
      l = half_line
    ),

    # axis attributes

    axis.text = ggplot2::element_text(size = base_size),
    axis.text.x = ggplot2::element_text(vjust = 1, margin = ggplot2::margin(t = 4L)),
    axis.text.y = ggplot2::element_text(hjust = 1),
    axis.text.x.top = NULL,
    axis.text.y.right = NULL,

    axis.title = ggplot2::element_text(#face = "italic",
      size = base_size),
    axis.title.x = ggplot2::element_text(margin = ggplot2::margin(t = 2L)),
    axis.title.y = ggplot2::element_text(angle = 90L,
                                         margin = ggplot2::margin(r = 8L)),
    axis.title.x.top = NULL,
    axis.title.y.right = NULL,

    axis.ticks = ggplot2::element_line(),
    axis.ticks.length = ggplot2::unit(4L, "pt"),
    axis.ticks.length.x = ggplot2::unit(4L, "pt"),
    axis.ticks.length.x.top = ggplot2::unit(4L, "pt"),
    axis.ticks.length.x.bottom = ggplot2::unit(4L, "pt"),
    axis.ticks.length.y = ggplot2::unit(4L, "pt"),
    axis.ticks.length.y.left = ggplot2::unit(4L, "pt"),
    axis.ticks.length.y.right = ggplot2::unit(4L, "pt"),

    axis.ticks.x = ggplot2::element_line(
      colour = NULL,
      size = NULL,
      linetype = NULL,
      lineend = NULL
    ),
    axis.ticks.y = ggplot2::element_blank(),

    axis.line = ggplot2::element_line(),
    axis.line.x = ggplot2::element_line(
      colour = NULL,
      size = NULL,
      linetype = NULL,
      lineend = NULL
    ),
    axis.line.y = ggplot2::element_line(),

    # legend attributes

    legend.background = ggplot2::element_blank(),

    legend.spacing = ggplot2::unit(20L, "pt"),
    legend.spacing.x = ggplot2::unit(4L, "pt"),
    legend.spacing.y = NULL,

    legend.key = ggplot2::element_blank(),
    legend.key.size = ggplot2::unit(10L, "pt"),
    legend.key.height = NULL,
    legend.key.width = NULL,

    legend.text = ggplot2::element_text(size = base_size,
                                        vjust = 1),
    legend.text.align = NULL,
    legend.title = ggplot2::element_text(size = base_size * 1.25,
                                         face = "bold"),
    legend.title.align = NULL,

    legend.position = "right",
    legend.direction = "vertical",
    legend.justification = NULL,
    legend.margin = ggplot2::margin(
      t = 6L,
      r = 0L,
      b = 6L,
      l = 0L,
      "pt"
    ),

    legend.box = "vertical",
    legend.box.margin = NULL,
    legend.box.background = NULL,
    legend.box.spacing = NULL,

    # panel attributes

    panel.background = ggplot2::element_blank(),
    panel.border = ggplot2::element_blank(),
    panel.ontop = FALSE,

    panel.spacing = ggplot2::unit(6L, "pt"),
    panel.spacing.x = NULL,
    panel.spacing.y = NULL,

    panel.grid = NULL,
    panel.grid.major = ggplot2::element_line(),
    panel.grid.major.x = ggplot2::element_blank(),
    panel.grid.major.y = ggplot2::element_line(colour = "#dedddd"),
    panel.grid.minor = ggplot2::element_line(),
    panel.grid.minor.x = ggplot2::element_blank(),
    panel.grid.minor.y = ggplot2::element_blank(),

    # strip attributes (Faceting)

    strip.background = ggplot2::element_rect(
      fill = "#dedddd",
      colour = NA,
      size = 10L
    ),
    strip.text = ggplot2::element_text(
      face = "bold",
      size = base_size * 9.5 / 8.5,
      margin = ggplot2::margin(
        t = 0L,
        r = 0L,
        b = 0L,
        l = 0L
      )
    ),

    strip.text.x = ggplot2::element_text(margin = ggplot2::margin(t = 4.5, b = 4.5)),
    strip.text.y = ggplot2::element_text(
      angle = -90L,
      margin = ggplot2::margin(l = 4.5, r = 4.5)
    ),

    strip.placement = "inside",
    strip.placement.x =  NULL,
    strip.placement.y =  NULL,

    strip.switch.pad.grid = ggplot2::unit(0.1, "cm"),
    strip.switch.pad.wrap = ggplot2::unit(0.1, "cm"),

    # create a complete format
    complete = TRUE

  )
}