R/print-ready.R

In stevethemes: Steve's 'ggplot2' Themes and Related Theme Elements

#' Miscellaneous functions to make your \pkg{ggplot2} plot "print-ready"
#'
#' @description These are assorted functions that will make your plot "print-ready"
#' by removing gridlines and giving hard-line axes to the plot. These are typically
#' changes requested by publishes for the printing process.
#'
#' @details  \code{no_gridlines()} is a simple wrapper for some basic
#' \pkg{ggplot2} code that will allow you to remove gridlines from the plot.
#' \code{make_classic()} removes gridlines, removes the default gray background,
#' *and* imposes a black, solid line on both axes. It will also hard code the
#' axis text to be black. Using the latter with the former is likely redundant.
#'
#' You will want to put these functions after a theme you've declared. If
#' you run this before adding a theme over it, the theme you add will probably
#' overwrite this function.
#'
#' @param ... optional, called for side effects
#'
#' @return \code{no_gridlines()} takes a plot made in \pkg{ggplot2} and removes
#' the gridlines from the plot before returning it to the user.
#' \code{make_classic()} takes a plot made in \pkg{ggplot2} and removes the
#' gridlines, gray background, and adds solid axes to the plot.
#'
#' @author Steven V. Miller
#'
#' @examples
#'
#' library(ggplot2)
#'
#' example_plot(type = "scatter")
#'
#' example_plot(type='scatter') + no_gridlines()
#'
#' example_plot(type='scatter') + make_classic()
#'

#' @rdname print-ready
#' @export
#'
no_gridlines <- function(...) {

  theme(panel.grid.major = element_blank(),
        panel.grid.minor = element_blank()) -> p

  return(p)
}

#' @rdname print-ready
#' @export
#'
make_classic <- function(...) {

  theme(panel.grid.major = element_blank(),
        panel.grid.minor = element_blank(),
        panel.background = element_blank(),
        axis.text.x = element_text(color="black"),
        axis.text.y = element_text(color="black"),
        axis.line = element_line(color = "black")) -> p

  return(p)
}