R/theme_hutchins.R

In Hutchins-Center/gghutchins: What the Package Does (One Line, Title Case)

#Define hutchins_theme() function

#' Hutchins Theme
#'
#' @return
#' @export
#'
#' @examples
theme_hutchins <- function(base_size = 12, base_family = "Roboto") {

  base_line_size = base_size/24
  base_rect_size = base_size/24
  half_line <- base_size / 2L
  border = FALSE
  ggplot2::"%+replace%"(
    ggplot2::theme_classic(base_size = base_size, base_family = base_family, base_line_size = base_line_size, base_rect_size = base_rect_size) ,
    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 = 1,
                                   margin = ggplot2::margin(),
                                   debug = FALSE),
      # Plot attributes
      plot.tag = ggtext::element_textbox_simple(size = base_size * 1.5,
                                       hjust = 0L,
                                       vjust = 0L,
                                       face = "bold",
                                       margin = ggplot2::margin(b = 10L)),
      plot.tag.position = "topleft",
      plot.title = ggtext::element_textbox_simple(size = base_size * 12 / 8.5,
                                         hjust = 0L,
                                         vjust = 0L,
                                         face = "bold",
                                         margin = ggplot2::margin(b = 10L),
                                         padding = margin(0, 0, 5, 0),
                                         color = '#003A79'),
      plot.title.position = "plot",
      plot.subtitle = ggtext::element_textbox_simple(size = base_size * 9.5 / 8.5,
                                            hjust = 0L,
                                            vjust = 0L,
                                            family = 'Roboto',
                                            padding = margin(0, 0, 5, 0),
                                            margin = ggplot2::margin(b = 10L)),
      plot.caption = ggtext::element_textbox_simple(size = base_size * 7 / 8.5,
                                           hjust = 0L,
                                           vjust = 0L,
                                           padding = margin(0, 0, 5, 0),
                                           margin = ggplot2::margin(t = half_line * 0.9),
                                           family = 'Roboto Light',
                                           color = '#525151'),
      plot.caption.position = "plot",
      plot.background = element_rect(fill = "#FAFAFA", color = "#FAFAFA"),

      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 = 0.8 * 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.ticks.length.x = NULL,
axis.ticks.length.x.top = NULL,
axis.ticks.length.x.bottom = NULL,
axis.ticks.length.y = NULL,
axis.ticks.length.y.left = NULL,
axis.ticks.length.y.right = NULL,

axis.title = ggplot2::element_text(family = 'Roboto Medium',
                                   size = base_size),
axis.title.x = ggplot2::element_blank(),
axis.title.y = ggplot2::element_blank(),
axis.title.x.top = NULL,
axis.title.y.right = NULL,

axis.ticks = ggplot2::element_line(),
axis.ticks.length = 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_blank(),

# 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 = ggtext::element_markdown(size = base_size * 7.5 / 8.5,
                                    vjust = 0.5,
                                    hjust = 0,
                                    family = 'Roboto'),
legend.text.align = 0,
legend.title = ggplot2::element_blank(),
legend.title.align = NULL,

legend.position = "top",
legend.direction = "horizontal",
legend.justification = 'left',
legend.margin = ggplot2::margin(t = 6L, r = 0L, b = 6L, l = 0L, "pt"),

legend.box = "horizontal",
legend.box.margin = NULL,
legend.box.background = NULL,
legend.box.spacing = unit(0.4, "cm"),

# 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 = "#cccccc",
                                           linetype = 'dotted',
                                           size = base_line_size * 1.5),
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")
    )
  )
}