Merge pull request #65 from best-practice-and-impact/fix-scales

Fix scale function argument names to work with ggplot2 v4.0.1

Author: zac-gleisner

.lintr

@@ -1,3 +1,3 @@
-linters: linters_with_defaults() # see vignette("lintr")
+linters: linters_with_defaults(object_name_linter = object_name_linter(styles = c("snake_case", "symbols", "dotted.case"))) # see vignette("lintr")
 exclude: "^#| fig.alt = "
 encoding: "UTF-8"

NEWS.md

@@ -1,5 +1,7 @@
 # afcharts (development version)
 
+- Renamed `na_colour` argument of `scale_colour_continuous_af` and `scale_fill_continuous_af` to `na.value`. This was necessary to enable `use_afcharts` to work with ggplot2 v4.0.1. Added `na.value` argument to `scale_colour_discrete_af` and `scale_fill_discrete_af`.
+
 - `use_afcharts` gains a `reset` argument to turn off analysis function styling of charts.
 
 - Set the `main` colour palettes to `categorical`. The Scale_*_discrete_af functions now use the 6 colour cateogrical palette by default, rather than the 4 colour.

R/scale_colour_continuous_af.R

@@ -7,7 +7,7 @@
 #'   supported. Defaults to "af".
 #' @param reverse Boolean value to indicate whether the palette should be
 #'   reversed.
-#' @param na_colour Colour to set for missing values.
+#' @param na.value Colour to set for missing values.
 #' @param guide A name or function used to create guide. Default is "colourbar".
 #' @param ... Additional arguments passed to scale type.
 #'
@@ -25,7 +25,7 @@
 scale_colour_continuous_af <- function(palette = "sequential",
                                        palette_type = c("af"),
                                        reverse = FALSE,
-                                       na_colour = "grey50",
+                                       na.value = "grey50",
                                        guide = "colourbar",
                                        ...) {
 
@@ -49,7 +49,7 @@ scale_colour_continuous_af <- function(palette = "sequential",
   ggplot2::continuous_scale(
     aesthetics = "colour",
     palette    = scales::gradient_n_pal(colours, values = NULL, "Lab"),
-    na.value   = na_colour,
+    na.value   = na.value,
     guide      = guide,
     ...
   )

R/scale_colour_discrete_af.R

@@ -7,6 +7,7 @@
 #'   supported. Defaults to "af".
 #' @param reverse Boolean value to indicate whether the palette should be
 #'   reversed.
+#' @param na.value Colour to set for missing values.
 #' @param ... Additional arguments passed to scale type.
 #'
 #' @returns ggplot2 discrete colour scale
@@ -30,12 +31,15 @@
 scale_colour_discrete_af <- function(palette = "categorical",
                                      palette_type = c("af"),
                                      reverse = FALSE,
+                                     na.value = "grey50",
                                      ...) {
 
   palette_type <- match.arg(palette_type)
 
-  ggplot2::discrete_scale("colour",
+  ggplot2::discrete_scale(
+    aesthetics = "colour",
     palette = af_palette(palette, reverse, palette_type = palette_type),
+    na.value = na.value,
     ...
   )
 }

R/scale_fill_continuous_af.R

@@ -7,7 +7,7 @@
 #'   supported. Defaults to "af".
 #' @param reverse Boolean value to indicate whether the palette should be
 #'   reversed.
-#' @param na_colour Colour to set for missing values.
+#' @param na.value Colour to set for missing values.
 #' @param guide A name or function used to create guide. Default is "colourbar".
 #' @param ... Additional arguments passed to scale type.
 #'
@@ -25,7 +25,7 @@
 scale_fill_continuous_af <- function(palette = "sequential",
                                      palette_type = c("af"),
                                      reverse = FALSE,
-                                     na_colour = "grey50",
+                                     na.value = "grey50",
                                      guide = "colourbar",
                                      ...) {
 
@@ -49,7 +49,7 @@ scale_fill_continuous_af <- function(palette = "sequential",
   ggplot2::continuous_scale(
     aesthetics = "fill",
     palette    = scales::gradient_n_pal(colours, values = NULL, "Lab"),
-    na.value   = na_colour,
+    na.value   = na.value,
     guide      = guide,
     ...
   )

R/scale_fill_discrete_af.R

@@ -7,6 +7,7 @@
 #'   supported. Defaults to "af".
 #' @param reverse Boolean value to indicate whether the palette should be
 #' reversed.
+#' @param na.value Colour to set for missing values.
 #' @param ... Additional arguments passed to scale type.
 #'
 #' @returns ggplot2 discrete fill scale
@@ -29,12 +30,15 @@
 scale_fill_discrete_af <- function(palette = "categorical",
                                    palette_type = c("af"),
                                    reverse = FALSE,
+                                   na.value = "grey50",
                                    ...) {
 
   palette_type <- match.arg(palette_type)
 
-  ggplot2::discrete_scale("fill",
+  ggplot2::discrete_scale(
+    aesthetics = "fill",
     palette = af_palette(palette, reverse, palette_type = palette_type),
+    na.value = na.value,
     ...
   )
 }