Merge pull request #191 from jrnold/hangonasecond-main

[feat] Add aliases for British spelling of colour

Author: jrnold

NAMESPACE

@@ -10,6 +10,7 @@ export(canva_pal)
 export(circlefill_shape_pal)
 export(cleveland_shape_pal)
 export(colorblind_pal)
+export(colourblind_pal)
 export(economist_pal)
 export(excel_new_pal)
 export(excel_pal)
@@ -46,6 +47,7 @@ export(scale_color_wsj)
 export(scale_colour_calc)
 export(scale_colour_canva)
 export(scale_colour_colorblind)
+export(scale_colour_colourblind)
 export(scale_colour_economist)
 export(scale_colour_excel)
 export(scale_colour_excel_new)
@@ -64,6 +66,7 @@ export(scale_colour_wsj)
 export(scale_fill_calc)
 export(scale_fill_canva)
 export(scale_fill_colorblind)
+export(scale_fill_colourblind)
 export(scale_fill_continuous_tableau)
 export(scale_fill_economist)
 export(scale_fill_excel)

NEWS.md

@@ -1,6 +1,9 @@
 # ggthemes (development version)
 
+- Renamed `scale_colour_colorblind()` to `scale_colour_colourblind()` (#180).
 - Updated `theme_solarized` to fix `key.background` color.
+- Bugfix: Fix documentation cross-links (#186)
+- Bugfix: Removed usage of deprecated ggplot functions
 
 # ggthemes 5.1.0
 

R/colorblind.R

@@ -23,16 +23,37 @@ colorblind_pal <- function() {
 
 #' @rdname colorblind
 #' @export
-scale_colour_colorblind <- function(...) {
+colourblind_pal <- colorblind_pal
+
+#' @rdname colorblind
+#' @export
+scale_colour_colourblind <- function(...) {
   discrete_scale("colour", palette = colorblind_pal(), ...)
 }
 
 #' @rdname colorblind
 #' @export
-scale_color_colorblind <- scale_colour_colorblind
+#' @importFrom lifecycle deprecate_soft
+scale_colour_colorblind <- function(...) {
+  deprecate_soft("5.2.0", "scale_color_colorblind()")
+  scale_colour_colourblind(...)
+}
 
 #' @rdname colorblind
 #' @export
+scale_color_colorblind <- scale_colour_colourblind
+
+#' @rdname colorblind
+#' @description
+#' `r lifecycle::badge("deprecated")`
+#'
+#' @export
+#' @importFrom lifecycle deprecate_soft
 scale_fill_colorblind <- function(...) {
+  deprecate_soft("5.2.0", "scale_fill_colorblind()")
   discrete_scale("fill", palette = colorblind_pal(), ...)
 }
+
+#' @rdname colorblind
+#' @export
+scale_fill_colourblind <- scale_fill_colorblind

inst/examples/ex-colorblind.R

@@ -9,4 +9,4 @@ p <- ggplot(mtcars) +
     colour = factor(gear)
   )) +
   facet_wrap(~am)
-p + theme_igray() + scale_colour_colorblind()
+p + theme_igray() + scale_colour_colourblind()

man/colorblind.Rd

@@ -9,12 +9,8 @@ test_that("colorblind_pal raises warning with to large n", {
   expect_warning(colorblind_pal()(20))
 })
 
-test_that("scale_colour_colorblind works", {
-  expect_s3_class(scale_colour_colorblind(), "ScaleDiscrete")
-})
-
-test_that("scale_color_canva works", {
-  expect_equal_scale(scale_color_colorblind(), scale_colour_colorblind())
+test_that("scale_colour_colourblind works", {
+  expect_s3_class(scale_colour_colourblind(), "ScaleDiscrete")
 })
 
 test_that("scale_fill_colorblind works", {