diff --git a/R/scale-brewer.r b/R/scale-brewer.r index b9c5a36eb6..ccbfc869ac 100644 --- a/R/scale-brewer.r +++ b/R/scale-brewer.r @@ -23,11 +23,15 @@ #' \item{Sequential}{Blues, BuGn, BuPu, GnBu, Greens, Greys, Oranges, #' OrRd, PuBu, PuBuGn, PuRd, Purples, RdPu, Reds, YlGn, YlGnBu, YlOrBr, YlOrRd} #' } +#' Modify the palette through the `palette` arguement. #' #' @inheritParams scales::brewer_pal #' @inheritParams scale_colour_hue #' @inheritParams scale_colour_gradient #' @inheritParams scales::gradient_n_pal +#' @param palette If a string, will use that named palette. If a number, will index into +#' the list of palettes of appropriate `type`. The list of available palettes can found +#' in the Palettes section. #' @param ... Other arguments passed on to [discrete_scale()] or, for #' `distiller` scales, [continuous_scale()] to control name, #' limits, breaks, labels and so forth. diff --git a/man/scale_brewer.Rd b/man/scale_brewer.Rd index e65b97f618..c44e785402 100644 --- a/man/scale_brewer.Rd +++ b/man/scale_brewer.Rd @@ -30,8 +30,9 @@ limits, breaks, labels and so forth.} \item{type}{One of seq (sequential), div (diverging) or qual (qualitative)} -\item{palette}{If a string, will use that named palette. If a number, will -index into the list of palettes of appropriate \code{type}} +\item{palette}{If a string, will use that named palette. If a number, will index into +the list of palettes of appropriate \code{type}. The list of available palettes can found +in the Palettes section.} \item{direction}{Sets the order of colours in the scale. If 1, the default, colours are as output by \code{\link[RColorBrewer:brewer.pal]{RColorBrewer::brewer.pal()}}. If -1, the @@ -79,6 +80,7 @@ The following palettes are available for use with these scales: \item{Sequential}{Blues, BuGn, BuPu, GnBu, Greens, Greys, Oranges, OrRd, PuBu, PuBuGn, PuRd, Purples, RdPu, Reds, YlGn, YlGnBu, YlOrBr, YlOrRd} } +Modify the palette through the \code{palette} arguement. } \examples{