Skip to content

Default to guide=colourbar for distiller scales #1017

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Default to guide=colourbar for distiller scales #1017

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f17a80f
Default to guide=colourbar for distiller scales
jiho Oct 5, 2014
f9e5b38
Add NEWS bit
jiho Oct 5, 2014
22d247a
Add documentation
jiho Apr 5, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions NEWS
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
MINOR IMPROVEMENTS

* `scale_colour_distiller()` and `scale_fill_distiller()` now use
`guide = "colourbar"` by default, as other continuous colour scales
(@jiho, #1017).

ggplot2 1.0.0
----------------------------------------------------------------

Expand Down
8 changes: 4 additions & 4 deletions R/scale-brewer.r
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,26 +67,26 @@ scale_fill_brewer <- function(..., type = "seq", palette = 1) {

#' @export
#' @rdname scale_brewer
scale_colour_distiller <- function(..., type = "seq", palette = 1, values = NULL, space = "Lab", na.value = "grey50") {
scale_colour_distiller <- function(..., type = "seq", palette = 1, values = NULL, space = "Lab", na.value = "grey50", guide = "colourbar") {
# warn about using a qualitative brewer palette to generate the gradient
type <- match.arg(type, c("seq", "div", "qual"))
if (type == "qual") {
warning("Using a discrete colour palette in a continuous scale.\n Consider using type = \"seq\" or type = \"div\" instead", call. = FALSE)
}
continuous_scale("colour", "distiller",
gradient_n_pal(brewer_pal(type, palette)(6), values, space), na.value = na.value, ...)
gradient_n_pal(brewer_pal(type, palette)(6), values, space), na.value = na.value, guide = guide, ...)
# NB: 6 colours per palette gives nice gradients; more results in more saturated colours which do not look as good
}

#' @export
#' @rdname scale_brewer
scale_fill_distiller <- function(..., type = "seq", palette = 1, values = NULL, space = "Lab", na.value = "grey50") {
scale_fill_distiller <- function(..., type = "seq", palette = 1, values = NULL, space = "Lab", na.value = "grey50", guide = "colourbar") {
type <- match.arg(type, c("seq", "div", "qual"))
if (type == "qual") {
warning("Using a discrete colour palette in a continuous scale.\n Consider using type = \"seq\" or type = \"div\" instead", call. = FALSE)
}
continuous_scale("fill", "distiller",
gradient_n_pal(brewer_pal(type, palette)(6), values, space), na.value = na.value, ...)
gradient_n_pal(brewer_pal(type, palette)(6), values, space), na.value = na.value, guide = guide, ...)
}

# icon.brewer <- function() {
Expand Down
19 changes: 11 additions & 8 deletions man/scale_brewer.Rd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,34 +13,37 @@ scale_colour_brewer(..., type = "seq", palette = 1)
scale_fill_brewer(..., type = "seq", palette = 1)

scale_colour_distiller(..., type = "seq", palette = 1, values = NULL,
space = "Lab", na.value = "grey50")
space = "Lab", na.value = "grey50", guide = "colourbar")

scale_fill_distiller(..., type = "seq", palette = 1, values = NULL,
space = "Lab", na.value = "grey50")
space = "Lab", na.value = "grey50", guide = "colourbar")

scale_color_brewer(..., type = "seq", palette = 1)

scale_color_distiller(..., type = "seq", palette = 1, values = NULL,
space = "Lab", na.value = "grey50")
space = "Lab", na.value = "grey50", guide = "colourbar")
}
\arguments{
\item{...}{Other arguments passed on to \code{\link{discrete_scale}}
to control name, 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{...}{Other arguments passed on to \code{\link{discrete_scale}}
to control name, limits, breaks, labels and so forth.}

\item{na.value}{Colour to use for missing values}

\item{values}{if colours should not be evenly positioned along the gradient
this vector gives the position (between 0 and 1) for each colour in the
\code{colours} vector. See \code{\link{rescale}} for a convience function
to map an arbitrary range to between 0 and 1.}

\item{space}{colour space in which to calculate gradient. "Lab" usually
best unless gradient goes through white.}

\item{na.value}{Colour to use for missing values}

\item{guide}{Type of legend. Use \code{"colourbar"} for continuous
colour bar, or \code{"legend"} for discrete colour legend.}
}
\description{
ColorBrewer provides sequential, diverging and qualitative colour schemes
Expand Down