Merge pull request #103 from CMAP-REPOS/scale_argument_passthroughs

Add ability to pass through scale arguments

Author: gritzenthaler

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: cmapplot
 Title: CMAP Themes and Color Palettes
-Version: 1.0.1
+Version: 1.0.2
 Authors@R: c(
     person("Matthew", "Stern",
            role = c("aut", "cre"),

R/colors_continuous.R

@@ -128,50 +128,57 @@ mid_rescaler2 <- function(mid) {
 #' @param reverse Logical; Reverse color order?
 #' @param middle Numeric; Sets midpoint for diverging color palettes. Default =
 #'   0.
+#' @param ... Additional parameters passed on to the scale type
 #'
 #' @examples
 #' ggplot(dplyr::filter(grp_over_time, cluster=="Biopharmaceuticals"),
 #'        aes(x = year, y = realgrp, color = realgrp)) +
 #'     geom_line() +
 #'     cmap_color_continuous(palette = "seq_red_purple")
 #'
-#' @describeIn cmap_fill_continuous For fill aesthetic
+#' @describeIn cmap_fill_continuous for fill aesthetic
 #'
 #' @export
 cmap_fill_continuous <- function(palette = "seq_reds",
                                  reverse = FALSE,
-                                 middle = 0) {
+                                 middle = 0,
+                                 ...) {
     if (substr(palette,1,3) == "div") {
         ggplot2::scale_fill_gradientn(
             colours = cmap_pal_continuous(palette, reverse = reverse)(256),
-            rescaler = mid_rescaler2(middle)
+            rescaler = mid_rescaler2(middle),
+            ...
         )
     } else {
         ggplot2::scale_fill_gradientn(
-            colours = cmap_pal_continuous(palette, reverse = reverse)(256)
+            colours = cmap_pal_continuous(palette, reverse = reverse)(256),
+            ...
         )
     }
 }
 
 
-#' @describeIn cmap_fill_continuous For color aesthetic
+#' @describeIn cmap_fill_continuous for color aesthetic
 #'
 #' @export
 cmap_color_continuous <- function(palette = "seq_reds",
                                   reverse = FALSE,
-                                  middle = 0) {
+                                  middle = 0,
+                                  ...) {
     if (substr(palette,1,3) == "div") {
         ggplot2::scale_colour_gradientn(
             colours = cmap_pal_continuous(palette, reverse = reverse)(256),
-            rescaler = mid_rescaler2(middle)
+            rescaler = mid_rescaler2(middle),
+            ...
         )
     } else {
         ggplot2::scale_colour_gradientn(
-            colours = cmap_pal_continuous(palette, reverse = reverse)(256)
+            colours = cmap_pal_continuous(palette, reverse = reverse)(256),
+            ...
         )
     }
 }
 
-#' @describeIn cmap_fill_continuous For color aesthetic
+#' @describeIn cmap_fill_continuous for color aesthetic
 #' @export
 cmap_colour_continuous <- cmap_color_continuous

R/colors_discrete.R

@@ -3,7 +3,7 @@
 #' A selection of discrete color palettes from the CMAP color palette.
 #'
 #' @examples
-#' # Get names of avialable discrete palettes.
+#' # Get names of available discrete palettes.
 #' # (Call viz_palette("name_of_palette") to preview one.)
 #' names(cmap_palettes)
 #'
@@ -63,6 +63,7 @@ viz_palette <- function(pal, ttl = deparse(substitute(pal)), num = length(pal))
 #'
 #' @param palette Choose from 'cmap_palettes' list
 #' @param reverse Logical; reverse color order?
+#' @param ... Additional parameters passed on to the scale type
 #'
 #' @noRd
 cmap_pal_discrete <- function(palette = "prosperity", reverse = FALSE) {
@@ -81,6 +82,7 @@ cmap_pal_discrete <- function(palette = "prosperity", reverse = FALSE) {
 #'
 #' @param palette Choose from 'cmap_palettes' list
 #' @param reverse Logical; reverse color order?
+#' @param ... Additional parameters passed on to the scale type
 #'
 #' @examples
 #' ggplot(pop_and_laborforce_by_age, aes(x = variable, y = value, fill = age)) +
@@ -94,17 +96,21 @@ cmap_pal_discrete <- function(palette = "prosperity", reverse = FALSE) {
 #'
 #' @describeIn cmap_fill_discrete For fill aesthetic
 #' @export
-cmap_fill_discrete <- function(palette = "prosperity", reverse = FALSE) {
+cmap_fill_discrete <- function(palette = "prosperity", reverse = FALSE, ...) {
     ggplot2::discrete_scale(
-        "fill", "cmap_palettes", palette = cmap_pal_discrete(palette, reverse = reverse)
+        "fill", "cmap_palettes",
+        palette = cmap_pal_discrete(palette, reverse = reverse),
+        ...
     )
 }
 
 #' @describeIn cmap_fill_discrete For color aesthetic
 #' @export
-cmap_color_discrete <- function(palette = "prosperity", reverse = FALSE) {
+cmap_color_discrete <- function(palette = "prosperity", reverse = FALSE, ...) {
     ggplot2::discrete_scale(
-        "colour", "cmap_palettes", palette = cmap_pal_discrete(palette, reverse = reverse)
+        "colour", "cmap_palettes",
+        palette = cmap_pal_discrete(palette, reverse = reverse),
+        ...
     )
 }