Export is.waive() for extensions to use (#6173)

* Export is.waive()

* Add NEWS bullet about is.waive

* Rename is.waive to is.waiver

Author: arcresu

NAMESPACE

@@ -475,6 +475,7 @@ export(is.scale)
 export(is.stat)
 export(is.theme)
 export(is.theme_element)
+export(is.waiver)
 export(label_both)
 export(label_bquote)
 export(label_context)

NEWS.md

@@ -1,5 +1,7 @@
 # ggplot2 (development version)
 
+* The helper function `is.waiver()` is now exported to help extensions to work
+  with `waiver()` objects (@arcresu, #6173).
 * Date(time) scales now throw appropriate errors when `date_breaks`, 
   `date_minor_breaks` or `date_labels` are not strings (@RodDalBen, #5880)
 * `geom_errorbarh()` is deprecated in favour of 

R/axis-secondary.R

@@ -129,7 +129,7 @@ is.sec_axis <- function(x) {
 }
 
 set_sec_axis <- function(sec.axis, scale) {
-  if (!is.waive(sec.axis)) {
+  if (!is.waiver(sec.axis)) {
     if (scale$is_discrete()) {
       if (!identical(.subset2(sec.axis, "trans"), identity)) {
         cli::cli_abort("Discrete secondary axes must have the {.fn identity} transformation.")
@@ -182,9 +182,9 @@ AxisSecondary <- ggproto("AxisSecondary", NULL,
     if (!is.function(transform)) {
       cli::cli_abort("Transformation for secondary axes must be a function.")
     }
-    if (is.derived(self$name) && !is.waive(scale$name)) self$name <- scale$name
+    if (is.derived(self$name) && !is.waiver(scale$name)) self$name <- scale$name
     if (is.derived(self$breaks)) self$breaks <- scale$breaks
-    if (is.waive(self$breaks)) {
+    if (is.waiver(self$breaks)) {
       if (scale$is_discrete()) {
         self$breaks <- scale$get_breaks()
       } else {

R/coord-sf.R

@@ -108,7 +108,7 @@ CoordSf <- ggproto("CoordSf", CoordCartesian,
     x_breaks <- graticule$degree[graticule$type == "E"]
     if (is.null(scale_x$labels)) {
       x_labels <- rep(NA, length(x_breaks))
-    } else if (is.waive(scale_x$labels)) {
+    } else if (is.waiver(scale_x$labels)) {
       x_labels <- graticule$degree_label[graticule$type == "E"]
       needs_autoparsing[graticule$type == "E"] <- TRUE
     } else {
@@ -133,7 +133,7 @@ CoordSf <- ggproto("CoordSf", CoordCartesian,
     y_breaks <- graticule$degree[graticule$type == "N"]
     if (is.null(scale_y$labels)) {
       y_labels <- rep(NA, length(y_breaks))
-    } else if (is.waive(scale_y$labels)) {
+    } else if (is.waiver(scale_y$labels)) {
       y_labels <- graticule$degree_label[graticule$type == "N"]
       needs_autoparsing[graticule$type == "N"] <- TRUE
     } else {
@@ -534,7 +534,7 @@ coord_sf <- function(xlim = NULL, ylim = NULL, expand = TRUE,
                      label_axes = waiver(), lims_method = "cross",
                      ndiscr = 100, default = FALSE, clip = "on") {
 
-  if (is.waive(label_graticule) && is.waive(label_axes)) {
+  if (is.waiver(label_graticule) && is.waiver(label_axes)) {
     # if both `label_graticule` and `label_axes` are set to waive then we
     # use the default of labels on the left and at the bottom
     label_graticule <- ""
@@ -620,13 +620,13 @@ sf_breaks <- function(scale_x, scale_y, bbox, crs) {
       bbox[is.na(bbox)] <- c(-180, -90, 180, 90)[is.na(bbox)]
     }
 
-    if (!(is.waive(scale_x$breaks) && is.null(scale_x$n.breaks))) {
+    if (!(is.waiver(scale_x$breaks) && is.null(scale_x$n.breaks))) {
       x_breaks <- scale_x$get_breaks(limits = bbox[c(1, 3)])
       finite <- is.finite(x_breaks)
       x_breaks <- if (any(finite)) x_breaks[finite] else NULL
     }
 
-    if (!(is.waive(scale_y$breaks) && is.null(scale_y$n.breaks))) {
+    if (!(is.waiver(scale_y$breaks) && is.null(scale_y$n.breaks))) {
       y_breaks <- scale_y$get_breaks(limits = bbox[c(2, 4)])
       finite <- is.finite(y_breaks)
       y_breaks <- if (any(finite)) y_breaks[finite] else NULL

R/facet-null.R

@@ -27,9 +27,9 @@ FacetNull <- ggproto("FacetNull", Facet,
     layout_null()
   },
   map_data = function(data, layout, params) {
-    # Need the is.waive check for special case where no data, but aesthetics
+    # Need the is.waiver check for special case where no data, but aesthetics
     # are mapped to vectors
-    if (is.waive(data))
+    if (is.waiver(data))
       return(data_frame0(PANEL = factor()))
 
     if (empty(data))

R/guide-axis-theta.R

@@ -200,7 +200,7 @@ GuideAxisTheta <- ggproto(
     }
 
     # Resolve text angle
-    if (is.waive(params$angle) || is.null(params$angle)) {
+    if (is.waiver(params$angle) || is.null(params$angle)) {
       angle <- elements$text$angle
     } else {
       angle <- flip_text_angle(params$angle - rad2deg(key$theta))
@@ -276,7 +276,7 @@ GuideAxisTheta <- ggproto(
     }
 
     # Resolve text angle
-    if (is.waive(params$angle %||% waiver())) {
+    if (is.waiver(params$angle %||% waiver())) {
       angle <- elements$text$angle
     } else {
       angle <- flip_text_angle(params$angle - rad2deg(key$theta))

R/guide-custom.R

@@ -96,7 +96,7 @@ GuideCustom <- ggproto(
     # Render title
     params <- replace_null(params, position = position, direction = direction)
     elems <- GuideLegend$setup_elements(params, self$elements, theme)
-    if (!is.waive(params$title) && !is.null(params$title)) {
+    if (!is.waiver(params$title) && !is.null(params$title)) {
       title <- self$build_title(params$title, elems, params)
     } else {
       title <- zeroGrob()

R/labels.R

@@ -152,7 +152,7 @@ labs <- function(..., title = waiver(), subtitle = waiver(), caption = waiver(),
     tag = tag, alt = allow_lambda(alt), alt_insight = alt_insight,
     .ignore_empty = "all")
 
-  is_waive <- vapply(args, is.waive, logical(1))
+  is_waive <- vapply(args, is.waiver, logical(1))
   args <- args[!is_waive]
   # remove duplicated arguments
   args <- args[!duplicated(names(args))]

R/layer.R

@@ -253,7 +253,7 @@ Layer <- ggproto("Layer", NULL,
   },
 
   layer_data = function(self, plot_data) {
-    if (is.waive(self$data)) {
+    if (is.waiver(self$data)) {
       data <- plot_data
     } else if (is.function(self$data)) {
       data <- self$data(plot_data)
@@ -263,7 +263,7 @@ Layer <- ggproto("Layer", NULL,
     } else {
       data <- self$data
     }
-    if (is.null(data) || is.waive(data)) data else unrowname(data)
+    if (is.null(data) || is.waiver(data)) data else unrowname(data)
   },
 
   # hook to allow a layer access to the final layer data

R/layout.R

@@ -283,7 +283,7 @@ Layout <- ggproto("Layout", NULL,
         } else {
           switch(label, x = ".bottom", y = ".right")
         }
-        if (is.null(labels[[label]][[i]]) || is.waive(labels[[label]][[i]]))
+        if (is.null(labels[[label]][[i]]) || is.waiver(labels[[label]][[i]]))
           return(zeroGrob())
 
         element_render(