rename prefix to theme_sub_*()

Author: teunbrand

NAMESPACE

@@ -707,28 +707,28 @@ export(summarise_layout)
 export(sym)
 export(syms)
 export(theme)
-export(theme_axis)
-export(theme_axis_bottom)
-export(theme_axis_left)
-export(theme_axis_right)
-export(theme_axis_top)
-export(theme_axis_x)
-export(theme_axis_y)
 export(theme_bw)
 export(theme_classic)
 export(theme_dark)
 export(theme_get)
 export(theme_gray)
 export(theme_grey)
-export(theme_legend)
 export(theme_light)
 export(theme_linedraw)
 export(theme_minimal)
-export(theme_panel)
-export(theme_plot)
 export(theme_replace)
 export(theme_set)
-export(theme_strip)
+export(theme_sub_axis)
+export(theme_sub_axis_bottom)
+export(theme_sub_axis_left)
+export(theme_sub_axis_right)
+export(theme_sub_axis_top)
+export(theme_sub_axis_x)
+export(theme_sub_axis_y)
+export(theme_sub_legend)
+export(theme_sub_panel)
+export(theme_sub_plot)
+export(theme_sub_strip)
 export(theme_test)
 export(theme_update)
 export(theme_void)

NEWS.md

@@ -1,7 +1,7 @@
 # ggplot2 (development version)
 
 * New function family for setting parts of a theme. For example, you can now use 
-  `theme_axis(line, text, ticks, ticks.length, line)` as a substitute for
+  `theme_sub_axis(line, text, ticks, ticks.length, line)` as a substitute for
   `theme(axis.line, axis.text, axis.ticks, axis.ticks.length, axis.line)`. This
   should allow slightly terser and more organised theme declarations 
   (@teunbrand, #5301).

R/theme-sub.R

@@ -26,7 +26,7 @@
 #' )
 #'
 #' # Are equivalent to these less verbose theme settings
-#' p + theme_axis_bottom(
+#' p + theme_sub_axis_bottom(
 #'   title = red_text,
 #'   text  = red_text,
 #'   line  = red_line,
@@ -54,85 +54,85 @@ subtheme <- function(elements, prefix = "", suffix = "", call = caller_env()) {
 
 #' @export
 #' @describeIn subtheme Theme specification for all axes.
-theme_axis <- function(title, text, ticks, ticks.length, line) {
+theme_sub_axis <- function(title, text, ticks, ticks.length, line) {
   subtheme(find_args(), "axis.")
 }
 
 #' @export
 #' @describeIn subtheme Theme specification for both x axes.
-theme_axis_x <- function(title, text, ticks, ticks.length, line) {
+theme_sub_axis_x <- function(title, text, ticks, ticks.length, line) {
   subtheme(find_args(), "axis.", ".x")
 }
 
 #' @export
 #' @describeIn subtheme Theme specification for both y axes.
-theme_axis_y <- function(title, text, ticks, ticks.length, line) {
+theme_sub_axis_y <- function(title, text, ticks, ticks.length, line) {
   subtheme(find_args(), "axis.", ".y")
 }
 
 #' @export
 #' @describeIn subtheme Theme specification for the bottom x axis.
-theme_axis_bottom <- function(title, text, ticks, ticks.length, line) {
+theme_sub_axis_bottom <- function(title, text, ticks, ticks.length, line) {
   subtheme(find_args(), "axis.", ".x.bottom")
 }
 
 #' @export
 #' @describeIn subtheme Theme specification for the top x axis.
-theme_axis_top <- function(title, text, ticks, ticks.length, line) {
+theme_sub_axis_top <- function(title, text, ticks, ticks.length, line) {
   subtheme(find_args(), "axis.", ".x.top")
 }
 
 #' @export
 #' @describeIn subtheme Theme specification for the left y axis.
-theme_axis_left <- function(title, text, ticks, ticks.length, line) {
+theme_sub_axis_left <- function(title, text, ticks, ticks.length, line) {
   subtheme(find_args(), "axis.", ".y.left")
 }
 
 #' @export
 #' @describeIn subtheme Theme specification for the right y axis.
-theme_axis_right <- function(title, text, ticks, ticks.length, line) {
+theme_sub_axis_right <- function(title, text, ticks, ticks.length, line) {
   subtheme(find_args(), "axis.", ".y.right")
 }
 
 #' @export
 #' @describeIn subtheme Theme specification for the legend.
-theme_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(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) {
   subtheme(find_args(), "legend.")
 }
 
 #' @export
 #' @describeIn subtheme Theme specification for the panels.
-theme_panel <- function(background, border, spacing, spacing.x, spacing.y,
-                        grid, grid.major, grid.minor, grid.major.x,
-                        grid.major.y, grid.minor.x, grid.minor.y, ontop) {
+theme_sub_panel <- function(background, border, 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.")
 }
 
 #' @export
 #' @describeIn subtheme Theme specification for the whole plot.
-theme_plot <- function(background, title, title.position, subtitle, caption,
-                       caption.position, tag, tag.position, tag.location,
-                       margin) {
+theme_sub_plot <- function(background, title, title.position, subtitle, caption,
+                           caption.position, tag, tag.position, tag.location,
+                           margin) {
   subtheme(find_args(), "plot.")
 }
 
 #' @export
 #' @describeIn subtheme Theme specification for facet strips.
-theme_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) {
+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) {
   subtheme(find_args(), "strip.")
 }
 
 subtheme_param_doc <- function() {
   funs <- list(
-    theme_axis, theme_axis_x, theme_axis_y, theme_axis_bottom,
-    theme_axis_top, theme_axis_left, theme_axis_right, theme_legend,
-    theme_panel, theme_plot, theme_strip
+    theme_sub_axis, theme_sub_axis_x, theme_sub_axis_y, theme_sub_axis_bottom,
+    theme_sub_axis_top, theme_sub_axis_left, theme_sub_axis_right, theme_sub_legend,
+    theme_sub_panel, theme_sub_plot, theme_sub_strip
   )
   args <- sort(unique(unlist(lapply(funs, fn_fmls_names), use.names = FALSE)))
   paste0(

man/subtheme.Rd

@@ -515,17 +515,17 @@ test_that("subtheme functions rename arguments as intended", {
   line <- element_line(colour = "red")
   rect <- element_rect(colour = "red")
 
-  expect_equal(theme_axis(ticks = line),        theme(axis.ticks = line))
-  expect_equal(theme_axis_x(ticks = line),      theme(axis.ticks.x = line))
-  expect_equal(theme_axis_y(ticks = line),      theme(axis.ticks.y = line))
-  expect_equal(theme_axis_top(ticks = line),    theme(axis.ticks.x.top = line))
-  expect_equal(theme_axis_bottom(ticks = line), theme(axis.ticks.x.bottom = line))
-  expect_equal(theme_axis_left(ticks = line),   theme(axis.ticks.y.left = line))
-  expect_equal(theme_axis_right(ticks = line),  theme(axis.ticks.y.right = line))
-  expect_equal(theme_legend(key = rect),        theme(legend.key = rect))
-  expect_equal(theme_panel(border = rect),      theme(panel.border = rect))
-  expect_equal(theme_plot(background = rect),   theme(plot.background = rect))
-  expect_equal(theme_strip(background = rect),  theme(strip.background = rect))
+  expect_equal(theme_sub_axis(ticks = line),        theme(axis.ticks = line))
+  expect_equal(theme_sub_axis_x(ticks = line),      theme(axis.ticks.x = line))
+  expect_equal(theme_sub_axis_y(ticks = line),      theme(axis.ticks.y = line))
+  expect_equal(theme_sub_axis_top(ticks = line),    theme(axis.ticks.x.top = line))
+  expect_equal(theme_sub_axis_bottom(ticks = line), theme(axis.ticks.x.bottom = line))
+  expect_equal(theme_sub_axis_left(ticks = line),   theme(axis.ticks.y.left = line))
+  expect_equal(theme_sub_axis_right(ticks = line),  theme(axis.ticks.y.right = line))
+  expect_equal(theme_sub_legend(key = rect),        theme(legend.key = rect))
+  expect_equal(theme_sub_panel(border = rect),      theme(panel.border = rect))
+  expect_equal(theme_sub_plot(background = rect),   theme(plot.background = rect))
+  expect_equal(theme_sub_strip(background = rect),  theme(strip.background = rect))
 
   # Test rejection of unknown theme elements
   expect_snapshot_warning(