R/theme_hugh.R

In HughParsonage/grattanCharts: Create Charts in the Style of the Grattan Insitute, Melbourne

#' A theme for use with ggplots
#' 
#' @name theme_hugh
#' @param base_size Size in points for the size of text.
#' @param base_family Typeface. If \code{NULL}, set to Helvetica if currently knitting and the font path exists. Otherwise to the default by ggplot2. 
#' @importFrom ggplot2 %+replace%
#' @importFrom ggplot2 element_line
#' @importFrom ggplot2 element_rect
#' @importFrom ggplot2 element_text
#' @importFrom ggplot2 element_blank
#' @export

theme_hugh <- function(base_size = 23, base_family = NULL) {
  if (is.null(base_family)) {
    if (requireNamespace("sysfonts", quietly = TRUE) &&
        "helvet" %in% sysfonts::font_families()) {
      base_family <- "helvet"
    } else {
      base_family <- ""
    }
  }
  
  ggplot2::theme_classic(base_size = base_size, 
                         base_family = base_family) %+replace%
    ggplot2::theme(
      
      # Base elements which are not used directly but inherited by others
      line =              element_line(colour = '#DADADA', size = 0.5, 
                                       linetype = 1, lineend = "butt"),
      rect =              element_rect(fill = "#F0F0F0", colour = "#F0F0F0", 
                                       size = 0.5, linetype = 1),
      text =              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.title = element_text(hjust = 0, vjust = 1.5),
      # Puts x lab in the centre, boldface
      axis.title.x =      element_text(hjust = 0.5, vjust = 0, 
                                       face = "bold",
                                       margin = ggplot2::margin(t = 11.5, b = 11.5)),
      axis.title.y =      element_blank(),
      axis.text =         element_text(),
      axis.line =         element_line(color = "black", size = 1),
      axis.line.x  = element_line(color = "black", size = 0.5), 
      axis.line.y  = element_blank(),
      axis.ticks.length = grid::unit(0.3, "lines"),
      
      # Modified inheritance structure of line element
      axis.ticks.x =        element_line(color = "black"),
      axis.ticks.y =        element_blank(),
      panel.grid.major =  element_line(),
      panel.grid.major.x = element_blank(),
      panel.grid.major.y = element_line(),
      panel.grid.minor =  element_blank(),
      
      # Modified inheritance structure of rect element
      plot.background =   element_blank(),
      plot.margin = grid::unit(c(0.7,0.1,0.5,0.00), "lines"),
      panel.background =  element_blank(),
      legend.key =        element_rect(fill='white', size = 0.5),
      legend.key.size = grid:: unit(1.5, "lines"), 
      legend.text = element_text(), 
      
      # Modifiying legend.position
      legend.position = 'none',
      legend.background = element_rect(fill = NA, colour = NA),
      legend.title = element_text(face = "bold"),
      strip.background = element_blank(),
      
      complete = TRUE
    )
}