R/scale_colour_pretty_div.R

In nrennie/PrettyCols: Pretty Colour Palettes

#' Plotting with PrettyCols palettes for colour ggplot2
#' @param palette Name of Palette. Run \code{view_all_palettes(type = "div")} to view
#' options. Must be a diverging palette name.
#' @param direction Sets order of colors. Default palette is 1. If direction is -1,
#' palette color order is reversed
#' @param legend_title `r lifecycle::badge("deprecated")` Deprecated in favour of `name`.
#' @param ... Other arguments passed on to \code{\link[ggplot2]{scale_colour_gradient2}}
#' @return A ggproto object defining a continuous colour scale for use with ggplot2.
#' @examples
#' library(ggplot2)
#' ggplot(data = mtcars, aes(x = mpg, y = disp, colour = wt)) +
#'   geom_point() +
#'   scale_colour_pretty_div("PurpleYellows", midpoint = mean(mtcars$wt))
#' @export

scale_colour_pretty_div <- scale_color_pretty_div