Rename guide_axis_custom() to guide_axis_base() (#24)

* rename function * rename inside other functions * rename in tests * accept snapshots * adapt additional documentation * fix typo
teunbrand · Oct 8, 2024 · 7ced72e · 7ced72e
1 parent 1e9a9cc
commit 7ced72e
Show file tree

Hide file tree

Showing 30 changed files with 103 additions and 103 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -40,7 +40,7 @@ export(gizmo_density)
 export(gizmo_grob)
 export(gizmo_histogram)
 export(gizmo_stepcap)
-export(guide_axis_custom)
+export(guide_axis_base)
 export(guide_axis_nested)
 export(guide_colbar)
 export(guide_colring)

diff --git a/NEWS.md b/NEWS.md
@@ -17,9 +17,9 @@ are represented.
 Full guides are guides that you can just drop in the `guides()` function or as
 `guide` argument to scales.
 
-* `guide_axis_custom()` as an axis guide.
-* `guide_colbar_custom()` as a continuous colour/fill guide.
-* `guide_colsteps_custom()` as a binned colour/fill guide.
+* `guide_axis_base()` as an axis guide.
+* `guide_colbar()` as a continuous colour/fill guide.
+* `guide_colsteps()` as a binned colour/fill guide.
 * `guide_colring()` as a continuous colour/fill guide.
 * `guide_subtitle()` as a colour/fill guide.
 

diff --git a/R/compose-ontop.R b/R/compose-ontop.R
@@ -16,14 +16,14 @@
 #' ggplot(mpg, aes(displ, hwy)) +
 #'   geom_point() +
 #'   guides(x = compose_ontop(
-#'     guide_axis_custom(
+#'     guide_axis_base(
 #'       key_manual(c(2, 4, 6)),
 #'       theme = theme(
 #'         axis.ticks = element_line(colour = "limegreen"),
 #'         axis.ticks.length = unit(11, "pt")
 #'       )
 #'     ),
-#'     guide_axis_custom(
+#'     guide_axis_base(
 #'       key_manual(c(3, 5, 7)),
 #'       theme = theme(
 #'         axis.ticks = element_line(colour = "tomato"),

diff --git a/R/compose-sandwich.R b/R/compose-sandwich.R
@@ -30,7 +30,7 @@
 #'   geom_point(aes(colour = cty)) +
 #'   guides(colour = compose_sandwich(
 #'     middle = "colourbar",
-#'     text = "axis_custom",
+#'     text = "axis_base",
 #'     opposite = primitive_bracket(key = key_range_manual(
 #'       start = c(10, 20), end = c(25, 30), name = c("A", "B")
 #'     ))

diff --git a/R/guide_axis_custom.R → R/guide_axis_base.R b/R/guide_axis_custom.R → R/guide_axis_base.R
@@ -35,10 +35,10 @@
 #' p <- ggplot(mpg, aes(displ, hwy)) +
 #'   geom_point() +
 #'   scale_x_continuous(
-#'     guide = guide_axis_custom(key = key_minor())
+#'     guide = guide_axis_base(key = key_minor())
 #'   ) +
 #'   scale_y_continuous(
-#'     guide = guide_axis_custom(key = key_manual(c(20, 25, 30, 40)))
+#'     guide = guide_axis_base(key = key_manual(c(20, 25, 30, 40)))
 #'   )
 #' p
 #'
@@ -50,9 +50,9 @@
 #'   geom_point(na.rm = TRUE) +
 #'   scale_x_continuous(
 #'     transform = "log10",
-#'     guide = guide_axis_custom("log")
+#'     guide = guide_axis_base("log")
 #'   )
-guide_axis_custom <- function(
+guide_axis_base <- function(
   key = NULL, title = waiver(), theme = NULL,
   n.dodge = 1, check.overlap = FALSE, angle = waiver(),
   cap = "none", bidi = FALSE, order = 0, position = waiver()

diff --git a/R/guide_colbar.R b/R/guide_colbar.R
@@ -78,7 +78,7 @@
 guide_colbar <- function(
   title = waiver(),
   key = "auto",
-  first_guide  = "axis_custom",
+  first_guide  = "axis_base",
   second_guide = first_guide,
   shape = "triangle",
   size = NULL,

diff --git a/R/guide_colring.R b/R/guide_colring.R
@@ -66,8 +66,8 @@ guide_colring <- function(
   key = "auto",
   start = 0,
   end = NULL,
-  outer_guide = "axis_custom",
-  inner_guide = "axis_custom",
+  outer_guide = "axis_base",
+  inner_guide = "axis_base",
   nbin = 300,
   reverse = FALSE,
   show_labels = "outer",

diff --git a/R/guide_colsteps.R b/R/guide_colsteps.R
@@ -70,15 +70,15 @@
 #' # Using tick marks by swapping side guides
 #' p + scale_colour_viridis_b(
 #'   guide = guide_colsteps(
-#'     first_guide  = "axis_custom",
-#'     second_guide = "axis_custom"
+#'     first_guide  = "axis_base",
+#'     second_guide = "axis_base"
 #'   )
 #' )
 guide_colsteps <- function(
   title = waiver(),
   key = "bins",
-  first_guide = "axis_custom",
-  second_guide = "axis_custom",
+  first_guide = "axis_base",
+  second_guide = "axis_base",
   shape = "triangle",
   size = NULL,
   show = NA,

diff --git a/README.Rmd b/README.Rmd
@@ -56,7 +56,7 @@ base <- ggplot(mpg, aes(displ, hwy, colour = cty)) +
 
 The gguidance package offers a selection of what it calls 'complete guides'. 
 These complete guides can just be drop-in replacement of regular guides, which you can specify using ggplot2's `guides()` function or using the `guide` argument in scales.
-In the example below, we're using two custom variants of vanilla guides, namely `guide_axis_custom()` and `guide_colbar()`. These custom variants have additional options that allow a greater degree of customisation: 
+In the example below, we're using two custom variants of vanilla guides, namely `guide_axis_base()` and `guide_colbar()`. These custom variants have additional options that allow a greater degree of customisation: 
 
 * The axis guide has an option for bidirectional ticks.
 * The colourbar automatically recognises out-of-bounds values and displays this with a cap.
@@ -68,7 +68,7 @@ base +
     guide = "colbar"
   ) +
   guides(
-    x = guide_axis_custom(bidi = TRUE)
+    x = guide_axis_base(bidi = TRUE)
   )
 ```
 
@@ -103,7 +103,7 @@ base +
   scale_colour_viridis_c(
     guide = compose_sandwich(
       middle = gizmo_density(), 
-      text = "axis_custom",
+      text = "axis_base",
       opposite = efficient_bracket
     )
   )

diff --git a/README.md b/README.md
@@ -49,7 +49,7 @@ guides’. These complete guides can just be drop-in replacement of
 regular guides, which you can specify using ggplot2’s `guides()`
 function or using the `guide` argument in scales. In the example below,
 we’re using two custom variants of vanilla guides, namely
-`guide_axis_custom()` and `guide_colbar()`. These custom variants have
+`guide_axis_base()` and `guide_colbar()`. These custom variants have
 additional options that allow a greater degree of customisation:
 
 - The axis guide has an option for bidirectional ticks.
@@ -63,7 +63,7 @@ base +
     guide = "colbar"
   ) +
   guides(
-    x = guide_axis_custom(bidi = TRUE)
+    x = guide_axis_base(bidi = TRUE)
   )
 ```
 
@@ -106,7 +106,7 @@ base +
   scale_colour_viridis_c(
     guide = compose_sandwich(
       middle = gizmo_density(), 
-      text = "axis_custom",
+      text = "axis_base",
       opposite = efficient_bracket
     )
   )

diff --git a/man/compose_ontop.Rd b/man/compose_ontop.Rd
diff --git a/man/compose_sandwich.Rd b/man/compose_sandwich.Rd
diff --git a/man/guide_axis_custom.Rd → man/guide_axis_base.Rd b/man/guide_axis_custom.Rd → man/guide_axis_base.Rd
diff --git a/man/guide_axis_nested.Rd b/man/guide_axis_nested.Rd
diff --git a/man/guide_colbar.Rd b/man/guide_colbar.Rd
diff --git a/man/guide_colring.Rd b/man/guide_colring.Rd
diff --git a/man/guide_colsteps.Rd b/man/guide_colsteps.Rd
diff --git a/...is_custom/guide-axis-custom-cartesian.svg → ...axis_custom/guide-axis-base-cartesian.svg b/...is_custom/guide-axis-custom-cartesian.svg → ...axis_custom/guide-axis-base-cartesian.svg
diff --git a/..._axis_custom/guide-axis-custom-radial.svg → ...de_axis_custom/guide-axis-base-radial.svg b/..._axis_custom/guide-axis-custom-radial.svg → ...de_axis_custom/guide-axis-base-radial.svg
diff --git a/...is_nested/guide-axis-nested-cartesian.svg → ...axis_nested/guide-axis-base-cartesian.svg b/...is_nested/guide-axis-nested-cartesian.svg → ...axis_nested/guide-axis-base-cartesian.svg
diff --git a/..._axis_nested/guide-axis-custom-radial.svg → ...de_axis_nested/guide-axis-base-radial.svg b/..._axis_nested/guide-axis-custom-radial.svg → ...de_axis_nested/guide-axis-base-radial.svg
diff --git a/tests/testthat/test-compose-crux.R b/tests/testthat/test-compose-crux.R
@@ -18,7 +18,7 @@ test_that("compose_crux can compose a legend", {
       legend.title = element_text(colour = col)
     )
     compose_stack(
-      guide_axis_custom,
+      guide_axis_base,
       primitive_title(title = col),
       theme = theme
     )

diff --git a/tests/testthat/test-compose-ontop.R b/tests/testthat/test-compose-ontop.R
@@ -14,7 +14,7 @@ test_that("compose_ontop works as axis line", {
 
   top <- compose_stack(
     primitive_spacer(unit(0.25, "cm")),
-    guide_axis_custom(
+    guide_axis_base(
       key_manual(c(2.5, 3.5, 4.5, 5.5, 6.5, 15, 25, 35)),
       theme = theme(
         axis.ticks = element_line(colour = "tomato"),
@@ -26,7 +26,7 @@ test_that("compose_ontop works as axis line", {
   )
 
   ontop <- compose_ontop(
-    guide_axis_custom(), top
+    guide_axis_base(), top
   )
 
   p <- base +

diff --git a/tests/testthat/test-compose_sandwich.R b/tests/testthat/test-compose_sandwich.R
@@ -2,7 +2,7 @@ test_that("compose_sandwich can compose a legend", {
 
   sandwich <- compose_sandwich(
     middle = guide_colourbar(theme = theme(text = element_text(colour = "limegreen"))),
-    text   = guide_axis_custom(theme = theme(text = element_text(colour = "tomato"))),
+    text   = guide_axis_base(theme = theme(text = element_text(colour = "tomato"))),
     opposite = primitive_bracket(key = key_range_manual(
       c(10, 20), c(25, 30), c("A", "B")
     ), theme = theme(text = element_text(colour = "dodgerblue")))