R/ggplot2.R

In paullemmens/lemmens-package: A Collection Of Functions

#' @title Collection Of Functions And Settings For Ggplot2
#'
#' @description
#' Over the years, I developed a personalized style/theme \code{theme_lemmens}
#' for use in ggplot2. In
#' earlier versions, this theme, and some other personalizations were in my
#' .Rprofile that I synced across machines via Tresorit. \code{lemmens_geoms()}
#' is an additional function that sets default values for various geoms that made
#' more sense with my default theme.
#'
#' @details
#' To make things a little clearer and more consistent with other packages' styles,
#' almost
#' all objects have been renamed. \emph{This will most definately break older scripts.}
#'
#' \code{lemmens_geoms(use = FALSE)} adapts default values for a series of geoms.
#' the \code{use} parameter defaults to FALSE, because I used bigger default
#' sizes in the days that I did not yet use Cairo. When the lemmens package is
#' loaded, \code{lemmens_geoms()} is automatically called.
#'
#' @export
theme_lemmens <- ggplot2::theme_bw() +
	ggplot2::theme(text = ggplot2::element_text(size = 18), 
                 axis.title.x = ggplot2::element_text(vjust = -0.2), 
                 axis.title.y = ggplot2::element_text(angle = 90, vjust = 1),
                 plot.caption = ggplot2::element_text(size = 11 * 0.8),
                 panel.border = ggplot2::element_rect(colour = 'black', size = 1.2),
                 strip.background  =  ggplot2::element_rect(colour  =  NA, fill  =  NA),
                 #strip.text  =  ggplot2::element_text(size  =  rel(1.0)),
                 legend.position = 'bottom')


## Different geom defaults that I predominantly used in my pre-Cairo days.
lemmens_geoms <- function(use=FALSE, reset=!use) {
	if (use) {
		ggplot2::update_geom_defaults('point', list(size=3.5))
		ggplot2::update_geom_defaults('errorbar', list(size=1.0, width=0.3))
		ggplot2::update_geom_defaults('line', list(size=1.5))
		ggplot2::update_geom_defaults('boxplot', list(size=0.8))
		ggplot2::update_geom_defaults('smooth', list(size=1.0))
	} else {
		ggplot2::update_geom_defaults('point', list(size=2))
		ggplot2::update_geom_defaults('errorbar', list(size=0.5, width=0.5))
		ggplot2::update_geom_defaults('line', list(size=0.5))
		ggplot2::update_geom_defaults('boxplot', list(size=0.5))
		ggplot2::update_geom_defaults('smooth', list(size=0.5))
	}
}

pd <- ggplot2::position_dodge(width=0.7)

#' Color Brewer Defaults for Theme Lemmens
#'
#' The function returns a list of \code{scale_*_brewer} scales with
#' specific settings that I like together with the \code{theme_lemmens}.
#' This reduces typing time.
#'
#' @param type String to indicate type scale: sequential, diverging, or
#'     qualitative (default).
#' @param palette One of my favorite palettes: Set1 (default), Paired,
#'     or Dark2.
#' @param ... Other parameters passed onward to other functions.
#'
#' @return A list that can be added to an existing ggplot object.
#'
#' @export
lemmens_brewer <- function(type = 'qual', palette = 'Set1', ...) {
  return(list(ggplot2::scale_fill_brewer(type = type, palette = palette, ...),
              ggplot2::scale_colour_brewer(type = type, palette = palette, ...)))
}

#' @title A personalized ggthemes::solarized dark theme.
#'
#' @description a list containing a series of adaptations to make a plot use the
#'     ggthemes::solarized theme (dark version) with personal adaptations
#'     particularly regarding strip and legend key background.
#'
#' @param accent String to indicate accent (starting) colour (default: blue).
#'
#' @export
lemmens_solarized <- function(accent = 'blue') {
  return(list(ggthemes::scale_colour_solarized(accent = accent),
              ggthemes::scale_fill_solarized(accent = accent),
              ggthemes::theme_solarized(light = FALSE),
              ggplot2::theme(strip.background = ggplot2::element_rect(colour = NA, fill = NA),
                            strip.text = ggplot2::element_text(colour = 'grey30'),
                            legend.key = ggplot2::element_rect(fill = NA)),
              ggplot2::guides(shape = ggplot2::guide_legend(override.aes = list(colour = 'grey60')))
              ))
}