R/theme-eedark.R

In ekholme/eemisc: Miscellaneous functions for ee

#' [ggplot2] theme based loosely on theme_ipsum from hrbrthemes.
#'
#' @seealso \code{link{theme_ee}}
#'
#' @param size base font size
#' @param base_font base font family
#' @param base_color color of text and ticks
#' @param accent_color color of grid lines
#' @param faceted logical. TRUE will reduce margins to make facets larger
#'
#' @return
#' @export
#'
#' @examples \dontrun{
#' library(ggplot2)
#' library(dplyr)
#'
#' #basic scatterplot
#' ggplot(mtcars, aes(mpg, wt)) +
#'   geom_point() +
#'   labs(x = "miles per gallon",
#'        y = "weight",
#'        title = "Scatterplot example",
#'        subtitle = "this is a subtitle",
#'        caption = "by bret bretterson") +
#'  theme_eedark()
#' }
#'
theme_eedark <- function(size = 10, base_font = "sans", base_color = "#cfd8dc", accent_color = "#717786",
                         faceted = FALSE) {
  half <- size / 2

  ret <- ggplot2::theme_minimal(base_family = base_font, base_size = size)

  #controlling plot margin if faceting
  plot.margin <- if (faceted == TRUE) {
    margin(t = 1.5*size, b = 1.5*size, l = .75*size, r = .75*size)
  } else {
    margin(t = 3*size, b = 3*size, l = 1.5*size, r = 1.5*size)
  }

  ret <- ret +
    theme(line = element_line(color = base_color, size = .3, linetype = 1),
        rect = element_rect(fill = "#343d52", color = base_color),
        text = element_text(family = base_font, face = "plain", color = base_color, size = .9*size, lineheight = .9),
        axis.line = element_blank(),
        axis.text = ggtext::element_markdown(size = size * .88, color = base_color),
        axis.ticks = element_line(color = base_color),
        axis.ticks.length = unit(half*.05, "pt"),
        axis.title = ggtext::element_markdown(size = size),
        legend.background = element_rect(color = NA),
        legend.margin = margin(.2, .2, .2, .2, "cm"),
        legend.key = element_rect(fill = "#343d52", color = NA),
        legend.key.size = unit(1.25, "lines"),
        legend.text = element_text(size = rel(.9)),
        legend.title = element_text(hjust = 0, size = rel(1)),
        panel.background = element_rect(fill = NA, color = NA),
        panel.border = element_blank(),
        panel.grid = element_blank(),
        panel.grid.major = element_line(size = .2, color = accent_color),
        panel.grid.minor = element_line(size = .2, color = accent_color),
        panel.spacing = unit(1.5*size, "pt"),
        strip.background = element_rect(fill = NA, color = NA),
        strip.text = ggtext::element_markdown(color = base_color, size = size, face = "bold"),
        strip.text.x = ggtext::element_markdown(margin = margin(t = half, b = half)),
        strip.text.y = ggtext::element_markdown(margin = margin(l = half, r = half)),
        plot.background = element_rect(color = NA),
        plot.title = ggtext::element_markdown(size = 1.7*size, face = "bold", margin = margin(b = .75*size)),
        plot.title.position = "plot",
        plot.subtitle = ggtext::element_markdown(size = size, margin = margin(b = .75*size)),
        plot.caption = ggtext::element_markdown(size = .8*size, face = "italic"),
        plot.caption.position = "plot",
        plot.margin = plot.margin
  )

  ret
}