Skip to content

typos; stick to en-GB; prefer project to website #4145

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

Merged
merged 2 commits into from
Jul 25, 2020
Merged

typos; stick to en-GB; prefer project to website #4145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be78540
typos; stick to en-GB; prefer project to website
stragu Jul 23, 2020
ee40d23
update doc for minor fixes
stragu Jul 24, 2020
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
12 changes: 6 additions & 6 deletions R/scale-brewer.r
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
#' Sequential, diverging and qualitative colour scales from colorbrewer.org
#' Sequential, diverging and qualitative colour scales from ColorBrewer
#'
#' @description
#' The `brewer` scales provides sequential, diverging and qualitative
#' The `brewer` scales provide sequential, diverging and qualitative
#' colour schemes from ColorBrewer. These are particularly well suited to
#' display discrete values on a map. See \url{http://colorbrewer2.org} for
#' more information.
#'
#' @note
#' The `distiller` scales extend brewer to continuous scales by smoothly
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel this should not be removed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed it because it is repeated later on in the same sentence: "...to a continuous scale." If you read it out loud I think you'll find it is quite wordy / repetitive.

The sentence needs to at least be reworded, as "extends brewer to continuous scales" is not the best wording, in my opinion.

Alternatively:

The distiller scales are continuous scales created by smoothly interpolating 7 colours from any brewer palette.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, sorry, I missed it. I see.

#' The `distiller` scales extend `brewer` scales by smoothly
#' interpolating 7 colours from any palette to a continuous scale. The `fermenter`
#' scales provide binned versions of the brewer scales.
#' scales provide binned versions of the `brewer` scales.
#'
#' @details
#' The `brewer` scales were carefully designed and tested on discrete data.
Expand All @@ -24,7 +24,7 @@
#' \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.
#' Modify the palette through the `palette` argument.
#'
#' @inheritParams scales::brewer_pal
#' @inheritParams scale_colour_hue
Expand Down Expand Up @@ -73,7 +73,7 @@
#' v + scale_fill_distiller()
#' v + scale_fill_distiller(palette = "Spectral")
#'
#' # or use blender variants to discretize continuous data
#' # or use blender variants to discretise continuous data
#' v + scale_fill_fermenter()
#'
scale_colour_brewer <- function(..., type = "seq", palette = 1, direction = 1, aesthetics = "colour") {
Expand Down
12 changes: 6 additions & 6 deletions man/scale_brewer.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.