Add missing theme sub args (#6492)

* add panel settings

* add minor ticks settings

* add test for covering theme_sub items

* add new arguments

* accept snapshot

Author: teunbrand

R/theme-sub.R

@@ -54,58 +54,73 @@ 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) {
+theme_sub_axis <- function(title, text, ticks, ticks.length, line, minor.ticks.length) {
   subtheme(find_args(), "axis.")
 }
 
 #' @export
 #' @describeIn subtheme Theme specification for both x axes.
-theme_sub_axis_x <- function(title, text, ticks, ticks.length, line) {
+theme_sub_axis_x <- function(title, text, ticks, ticks.length, line, minor.ticks.length) {
   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) {
+theme_sub_axis_y <- function(title, text, ticks, ticks.length, line, minor.ticks.length) {
   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) {
+theme_sub_axis_bottom <- function(title, text, ticks, ticks.length, line, minor.ticks, minor.ticks.length) {
   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) {
+theme_sub_axis_top <- function(title, text, ticks, ticks.length, line, minor.ticks, minor.ticks.length) {
   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) {
+theme_sub_axis_left <- function(title, text, ticks, ticks.length, line, minor.ticks, minor.ticks.length) {
   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) {
+theme_sub_axis_right <- function(title, text, ticks, ticks.length, line, minor.ticks, minor.ticks.length) {
   subtheme(find_args(), "axis.", ".y.right")
 }
 
 #' @export
 #' @describeIn subtheme Theme specification for the legend.
-theme_sub_legend <- function(background, margin, spacing, spacing.x, spacing.y,
-                             key, key.size, key.height, key.width, text, title,
-                             position, direction, justification, box, box.just,
-                             box.margin, box.background, box.spacing) {
+theme_sub_legend <- function(
+  # Text stuff
+  text, text.position, title, title.position,
+  # Drawn elements
+  background, frame, ticks, ticks.length, axis.line,
+  # Spacings
+  spacing, spacing.x, spacing.y,   margin,
+  # Seys
+  key, key.size, key.height, key.width, key.spacing, key.spacing.x,
+  key.spacing.y, key.justification,
+  # Settings
+  byrow, position, direction, location, position.inside,
+  # Justification
+  justification, justification.top, justification.bottom, justification.left,
+  justification.right, justification.inside,
+  # Box
+  box, box.just, box.margin, box.background, box.spacing
+) {
   subtheme(find_args(), "legend.")
 }
 
 #' @export
 #' @describeIn subtheme Theme specification for the panels.
-theme_sub_panel <- function(background, border, spacing, spacing.x, spacing.y,
+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) {
   subtheme(find_args(), "panel.")

man/subtheme.Rd

@@ -134,3 +134,22 @@
     The `options('ggplot2.discrete.colour')` setting is incompatible with the `palette.colour.discrete` theme setting.
     i You can set `options(ggplot2.discrete.colour = NULL)`.
 
+# theme elements are covered in `theme_sub_*()` functions
+
+    Code
+      extra_elements
+    Output
+       [1] "..."                           "line"                         
+       [3] "rect"                          "text"                         
+       [5] "title"                         "point"                        
+       [7] "polygon"                       "geom"                         
+       [9] "spacing"                       "margins"                      
+      [11] "aspect.ratio"                  "axis.text.theta"              
+      [13] "axis.text.r"                   "axis.ticks.theta"             
+      [15] "axis.ticks.r"                  "axis.minor.ticks.theta"       
+      [17] "axis.minor.ticks.r"            "axis.ticks.length.theta"      
+      [19] "axis.ticks.length.r"           "axis.minor.ticks.length.theta"
+      [21] "axis.minor.ticks.length.r"     "axis.line.theta"              
+      [23] "axis.line.r"                   "complete"                     
+      [25] "validate"                     
+

tests/testthat/_snaps/theme.md

@@ -763,6 +763,28 @@ test_that("geom elements are inherited correctly", {
   expect_equal(p$colour, "red")
 })
 
+test_that("theme elements are covered in `theme_sub_*()` functions", {
+  # We use a snapshot test here to trigger when a new theme element is added
+  # or removed.
+  # A failure of this test should be taken as a prompt to see if the new
+  # theme element should be included in one of the `theme_sub_*` functions.
+
+  fmls <- paste0("axis.", fn_fmls_names(theme_sub_axis))
+  fmls <- c(fmls, paste0("axis.",   fn_fmls_names(theme_sub_axis_x), ".x"))
+  fmls <- c(fmls, paste0("axis.",   fn_fmls_names(theme_sub_axis_y), ".y"))
+  fmls <- c(fmls, paste0("axis.",   fn_fmls_names(theme_sub_axis_top), ".x.top"))
+  fmls <- c(fmls, paste0("axis.",   fn_fmls_names(theme_sub_axis_bottom), ".x.bottom"))
+  fmls <- c(fmls, paste0("axis.",   fn_fmls_names(theme_sub_axis_left), ".y.left"))
+  fmls <- c(fmls, paste0("axis.",   fn_fmls_names(theme_sub_axis_right), ".y.right"))
+  fmls <- c(fmls, paste0("legend.", fn_fmls_names(theme_sub_legend)))
+  fmls <- c(fmls, paste0("plot.",   fn_fmls_names(theme_sub_plot)))
+  fmls <- c(fmls, paste0("panel.",  fn_fmls_names(theme_sub_panel)))
+  fmls <- c(fmls, paste0("strip.",  fn_fmls_names(theme_sub_strip)))
+
+  extra_elements <- setdiff(fn_fmls_names(theme), fmls)
+  expect_snapshot(extra_elements)
+})
+
 # Visual tests ------------------------------------------------------------
 
 test_that("element_polygon() can render a grob", {