Use ellipsis argument in theme_sub_*() family (#6655)

* Comment to clarify when to use `warn_dots_*()` functions

* add ellipses to `theme_sub_*()` family

* document `...`

Author: teunbrand

R/theme-sub.R

@@ -5,6 +5,7 @@
 #' keeping theme declarations more organised.
 #'
 #' @eval subtheme_param_doc()
+#' @param ... Not in use, expected to be empty.
 #'
 #' @return A `theme`-class object that can be added to a plot.
 #' @name subtheme
@@ -54,49 +55,57 @@ subtheme <- function(elements, prefix = "", suffix = "", call = caller_env()) {
 
 #' @export
 #' @describeIn subtheme Theme specification for all axes.
-theme_sub_axis <- function(title, text, ticks, ticks.length, line, minor.ticks.length) {
+theme_sub_axis <- function(..., title, text, ticks, ticks.length, line, minor.ticks.length) {
+  warn_dots_empty()
   subtheme(find_args(), "axis.")
 }
 
 #' @export
 #' @describeIn subtheme Theme specification for both x axes.
-theme_sub_axis_x <- function(title, text, ticks, ticks.length, line, minor.ticks.length) {
+theme_sub_axis_x <- function(..., title, text, ticks, ticks.length, line, minor.ticks.length) {
+  warn_dots_empty()
   subtheme(find_args(), "axis.", ".x")
 }
 
 #' @export
 #' @describeIn subtheme Theme specification for both y axes.
-theme_sub_axis_y <- function(title, text, ticks, ticks.length, line, minor.ticks.length) {
+theme_sub_axis_y <- function(..., title, text, ticks, ticks.length, line, minor.ticks.length) {
+  warn_dots_empty()
   subtheme(find_args(), "axis.", ".y")
 }
 
 #' @export
 #' @describeIn subtheme Theme specification for the bottom x axis.
-theme_sub_axis_bottom <- function(title, text, ticks, ticks.length, line, minor.ticks, minor.ticks.length) {
+theme_sub_axis_bottom <- function(..., title, text, ticks, ticks.length, line, minor.ticks, minor.ticks.length) {
+  warn_dots_empty()
   subtheme(find_args(), "axis.", ".x.bottom")
 }
 
 #' @export
 #' @describeIn subtheme Theme specification for the top x axis.
-theme_sub_axis_top <- function(title, text, ticks, ticks.length, line, minor.ticks, minor.ticks.length) {
+theme_sub_axis_top <- function(..., title, text, ticks, ticks.length, line, minor.ticks, minor.ticks.length) {
+  warn_dots_empty()
   subtheme(find_args(), "axis.", ".x.top")
 }
 
 #' @export
 #' @describeIn subtheme Theme specification for the left y axis.
-theme_sub_axis_left <- function(title, text, ticks, ticks.length, line, minor.ticks, minor.ticks.length) {
+theme_sub_axis_left <- function(..., title, text, ticks, ticks.length, line, minor.ticks, minor.ticks.length) {
+  warn_dots_empty()
   subtheme(find_args(), "axis.", ".y.left")
 }
 
 #' @export
 #' @describeIn subtheme Theme specification for the right y axis.
-theme_sub_axis_right <- function(title, text, ticks, ticks.length, line, minor.ticks, minor.ticks.length) {
+theme_sub_axis_right <- function(..., title, text, ticks, ticks.length, line, minor.ticks, minor.ticks.length) {
+  warn_dots_empty()
   subtheme(find_args(), "axis.", ".y.right")
 }
 
 #' @export
 #' @describeIn subtheme Theme specification for the legend.
 theme_sub_legend <- function(
+  ...,
   # Text stuff
   text, text.position, title, title.position,
   # Drawn elements
@@ -114,32 +123,36 @@ theme_sub_legend <- function(
   # Box
   box, box.just, box.margin, box.background, box.spacing
 ) {
+  warn_dots_empty()
   subtheme(find_args(), "legend.")
 }
 
 #' @export
 #' @describeIn subtheme Theme specification for the panels.
-theme_sub_panel <- function(background, border,
+theme_sub_panel <- function(..., background, border,
                             widths, heights, spacing, spacing.x, spacing.y,
                             grid, grid.major, grid.minor, grid.major.x,
                             grid.major.y, grid.minor.x, grid.minor.y, ontop) {
+  warn_dots_empty()
   subtheme(find_args(), "panel.")
 }
 
 #' @export
 #' @describeIn subtheme Theme specification for the whole plot.
-theme_sub_plot <- function(background, title, title.position, subtitle, caption,
+theme_sub_plot <- function(..., background, title, title.position, subtitle, caption,
                            caption.position, tag, tag.position, tag.location,
                            margin) {
+  warn_dots_empty()
   subtheme(find_args(), "plot.")
 }
 
 #' @export
 #' @describeIn subtheme Theme specification for facet strips.
-theme_sub_strip <- function(background, background.x, background.y, clip,
+theme_sub_strip <- function(..., background, background.x, background.y, clip,
                             placement, text, text.x, text.x.bottom, text.x.top,
                             text.y, text.y.left, text.y.right,
                             switch.pad.grid, switch.pad.wrap) {
+  warn_dots_empty()
   subtheme(find_args(), "strip.")
 }
 
@@ -150,6 +163,7 @@ subtheme_param_doc <- function() {
     theme_sub_panel, theme_sub_plot, theme_sub_strip
   )
   args <- sort(unique(unlist(lapply(funs, fn_fmls_names), use.names = FALSE)))
+  args <- setdiff(args, "...")
   paste0(
     "@param ",
     paste0(args, collapse = ","),

R/utilities.R

@@ -810,6 +810,36 @@ size0 <- function(x) {
   }
 }
 
+fallback_palette <- function(scale) {
+  aes <- scale$aesthetics[1]
+  discrete <- scale$is_discrete()
+  if (discrete) {
+    pal <- switch(
+      aes,
+      colour = , fill = pal_hue(),
+      alpha = function(n) seq(0.1, 1, length.out = n),
+      linewidth = function(n) seq(2, 6, length.out = n),
+      linetype = pal_linetype(),
+      shape = pal_shape(),
+      size = function(n) sqrt(seq(4, 36, length.out = n)),
+      ggplot_global$theme_default[[paste0("palette.", aes, ".discrete")]]
+    )
+    return(pal)
+  }
+  switch(
+    aes,
+    colour = , fill = pal_seq_gradient("#132B43", "#56B1F7"),
+    alpha = pal_rescale(c(0.1, 1)),
+    linewidth = pal_rescale(c(1, 6)),
+    linetype = pal_binned(pal_linetype()),
+    shape = pal_binned(pal_shape()),
+    size = pal_area(),
+    ggplot_global$theme_default[[paste0("palette.", aes, ".continuous")]]
+  )
+}
+
+# For when you want to ensure all forwarded arguments are consumed by downstream
+# functions.
 warn_dots_used <- function(env = caller_env(), call = caller_env()) {
   check_dots_used(
     env = env, call = call,
@@ -822,6 +852,7 @@ warn_dots_used <- function(env = caller_env(), call = caller_env()) {
   )
 }
 
+# For when you do not want `...` to be used; it should be empty.
 warn_dots_empty <- function(env = caller_env(), call = caller_env()) {
   check_dots_empty(
     env = env, call = call,