Swap underscore arguments for dot-case arguments (#5754)

* deprecate underscore args in `coord_radial()`

* deprecate underscore args in `guide_axis_logticks()`

* use snapshot text for underscore arguments

* redocument

* Swap args in tests

* sort snapshot

* forgot to update snapshot

Author: teunbrand

R/coord-radial.R

@@ -7,15 +7,16 @@
 #' @param expand If `TRUE`, the default, adds a small expansion factor the
 #'   the limits to prevent overlap between data and axes. If `FALSE`, limits
 #'   are taken directly from the scale.
-#' @param r_axis_inside If `TRUE`, places the radius axis inside the
+#' @param r.axis.inside If `TRUE`, places the radius axis inside the
 #'   panel. If `FALSE`, places the radius axis next to the panel. The default,
 #'   `NULL`, places the radius axis outside if the `start` and `end` arguments
 #'   form a full circle.
-#' @param rotate_angle If `TRUE`, transforms the `angle` aesthetic in data
+#' @param rotate.angle If `TRUE`, transforms the `angle` aesthetic in data
 #'   in accordance with the computed `theta` position. If `FALSE` (default),
 #'   no such transformation is performed. Can be useful to rotate text geoms in
 #'   alignment with the coordinates.
 #' @param inner.radius A `numeric` between 0 and 1 setting the size of a inner.radius hole.
+#' @param r_axis_inside,rotate_angle `r lifecycle::badge("deprecated")`
 #'
 #' @note
 #' In `coord_radial()`, position guides are can be defined by using
@@ -36,15 +37,30 @@ coord_radial <- function(theta = "x",
                          expand = TRUE,
                          direction = 1,
                          clip = "off",
-                         r_axis_inside = NULL,
-                         rotate_angle = FALSE,
-                         inner.radius = 0) {
+                         r.axis.inside = NULL,
+                         rotate.angle = FALSE,
+                         inner.radius = 0,
+                         r_axis_inside = deprecated(),
+                         rotate_angle = deprecated()) {
+
+  if (lifecycle::is_present(r_axis_inside)) {
+    deprecate_warn0(
+      "3.5.1", "coord_radial(r_axis_inside)", "coord_radial(r.axis.inside)"
+    )
+    r.axis.inside <- r_axis_inside
+  }
+  if (lifecycle::is_present(rotate_angle)) {
+    deprecate_warn0(
+      "3.5.1", "coord_radial(rotate_angle)", "coord_radial(rotate.angle)"
+    )
+    rotate.angle <- rotate_angle
+  }
 
   theta <- arg_match0(theta, c("x", "y"))
   r <- if (theta == "x") "y" else "x"
-  check_bool(r_axis_inside, allow_null = TRUE)
+  check_bool(r.axis.inside, allow_null = TRUE)
   check_bool(expand)
-  check_bool(rotate_angle)
+  check_bool(rotate.angle)
   check_number_decimal(start, allow_infinite = FALSE)
   check_number_decimal(end, allow_infinite = FALSE, allow_null = TRUE)
   check_number_decimal(inner.radius, min = 0, max = 1, allow_infinite = FALSE)
@@ -54,16 +70,16 @@ coord_radial <- function(theta = "x",
     n_rotate <- ((start - end) %/% (2 * pi)) + 1
     start <- start - n_rotate * 2 * pi
   }
-  r_axis_inside <- r_axis_inside %||% !(abs(end - start) >= 1.999 * pi)
+  r.axis.inside <- r.axis.inside %||% !(abs(end - start) >= 1.999 * pi)
 
   ggproto(NULL, CoordRadial,
     theta = theta,
     r = r,
     arc = c(start, end),
     expand = expand,
     direction = sign(direction),
-    r_axis_inside = r_axis_inside,
-    rotate_angle = rotate_angle,
+    r_axis_inside = r.axis.inside,
+    rotate_angle = rotate.angle,
     inner_radius = c(inner.radius, 1) * 0.4,
     clip = clip
   )

R/guide-axis-logticks.R

@@ -10,19 +10,20 @@ NULL
 #'   the (relative) length of the long, middle and short ticks. Numeric values
 #'   are interpreted as [rel()] objects. The [rel()] values are used to multiply
 #'   values of the `axis.ticks.length` theme setting.
-#' @param prescale_base Base of logarithm used to transform data manually. The
+#' @param prescale.base Base of logarithm used to transform data manually. The
 #'   default, `NULL`, will use the scale transformation to calculate positions.
-#'   Only set `prescale_base` if the data has already been log-transformed.
+#'   Only set `prescale.base` if the data has already been log-transformed.
 #'   When using a log-transform in the position scale or in `coord_trans()`,
 #'   keep the default `NULL` argument.
-#' @param negative_small When the scale limits include 0 or negative numbers,
+#' @param negative.small When the scale limits include 0 or negative numbers,
 #'   what should be the smallest absolute value that is marked with a tick?
-#' @param short_theme A theme [element][element_line()] for customising the
+#' @param short.theme A theme [element][element_line()] for customising the
 #'   display of the shortest ticks. Must be a line or blank element, and
 #'   it inherits from the `axis.minor.ticks` setting for the relevant position.
 #' @param expanded Whether the ticks should cover the range after scale
 #'   expansion (`TRUE`, default), or be restricted to the scale limits
 #'   (`FALSE`).
+#' @param prescale_base,negative_small,short_theme `r lifecycle::badge("deprecated")`
 #' @inheritParams guide_axis
 #' @inheritDotParams guide_axis -minor.ticks
 #'
@@ -41,12 +42,12 @@ NULL
 #' p + coord_trans(x = "log10", y = "log10") +
 #'   guides(x = "axis_logticks", y = "axis_logticks")
 #'
-#' # When data is transformed manually, one should provide `prescale_base`
+#' # When data is transformed manually, one should provide `prescale.base`
 #' # Keep in mind that this axis uses log10 space for placement, not log2
 #' p + aes(x = log2(bodywt), y = log10(brainwt)) +
 #'   guides(
-#'     x = guide_axis_logticks(prescale_base = 2),
-#'     y = guide_axis_logticks(prescale_base = 10)
+#'     x = guide_axis_logticks(prescale.base = 2),
+#'     y = guide_axis_logticks(prescale.base = 10)
 #'   )
 #'
 #' # A plot with both positive and negative extremes, pseudo-log transformed
@@ -61,20 +62,42 @@ NULL
 #' # The log ticks are mirrored when 0 is included
 #' p2 + guides(x = "axis_logticks")
 #'
-#' # To control the tick density around 0, one can set `negative_small`
-#' p2 + guides(x = guide_axis_logticks(negative_small = 1))
+#' # To control the tick density around 0, one can set `negative.small`
+#' p2 + guides(x = guide_axis_logticks(negative.small = 1))
 guide_axis_logticks <- function(
   long  = 2.25,
   mid   = 1.5,
   short = 0.75,
-  prescale_base = NULL,
-  negative_small = 0.1,
-  short_theme = element_line(),
+  prescale.base = NULL,
+  negative.small = 0.1,
+  short.theme = element_line(),
   expanded = TRUE,
   cap = "none",
   theme = NULL,
+  prescale_base = deprecated(),
+  negative_small = deprecated(),
+  short_theme = deprecated(),
   ...
 ) {
+  if (lifecycle::is_present(prescale_base)) {
+    deprecate_warn0(
+      "3.5.1", "guide_axis_logticks(prescale_base)", "guide_axis_logticks(prescale.base)"
+    )
+    prescale.base <- prescale_base
+  }
+  if (lifecycle::is_present(negative_small)) {
+    deprecate_warn0(
+      "3.5.1", "guide_axis_logticks(negative_small)", "guide_axis_logticks(negative.small)"
+    )
+    negative.small <- negative_small
+  }
+  if (lifecycle::is_present(short_theme)) {
+    deprecate_warn0(
+      "3.5.1", "guide_axis_logticks(short_theme)", "guide_axis_logticks(short.theme)"
+    )
+    short.theme <- short_theme
+  }
+
   if (is.logical(cap)) {
     check_bool(cap)
     cap <- if (cap) "both" else "none"
@@ -91,24 +114,24 @@ guide_axis_logticks <- function(
   check_object(mid,   check_fun, what)
   check_object(short, check_fun, what)
   check_number_decimal(
-    negative_small, min = 1e-100, # minimal domain of scales::log_trans
+    negative.small, min = 1e-100, # minimal domain of scales::log_trans
     allow_infinite = FALSE,
     allow_null = TRUE
   )
   check_bool(expanded)
-  check_inherits(short_theme, c("element_blank", "element_line"))
+  check_inherits(short.theme, c("element_blank", "element_line"))
 
   new_guide(
     available_aes  = c("x", "y"),
-    prescale_base  = prescale_base,
-    negative_small = negative_small,
+    prescale_base  = prescale.base,
+    negative_small = negative.small,
     expanded       = expanded,
     long  = long,
     mid   = mid,
     short = short,
     cap   = cap,
     minor.ticks = TRUE,
-    short_theme = short_theme,
+    short_theme = short.theme,
     theme = theme,
     ...,
     super = GuideAxisLogticks
@@ -152,7 +175,7 @@ GuideAxisLogticks <- ggproto(
       trans_name <- scale$get_transformation()$name
       if (trans_name != "identity") {
         cli::cli_warn(paste0(
-          "The {.arg prescale_base} argument will override the scale's ",
+          "The {.arg prescale.base} argument will override the scale's ",
           "{.field {trans_name}} transformation in log-tick positioning."
         ))
       }

man/coord_polar.Rd

@@ -54,7 +54,7 @@
 
 # guide_axis_logticks calculates appropriate ticks
 
-    The `prescale_base` argument will override the scale's log-10 transformation in log-tick positioning.
+    The `prescale.base` argument will override the scale's log-10 transformation in log-tick positioning.
 
 # binning scales understand the different combinations of limits, breaks, labels, and show.limits