necromancy: resurrect stat_bin(drop) by sacrificing stat_bin(keep.zeroes)

Author: teunbrand

NEWS.md

@@ -225,7 +225,7 @@
 * The ellipsis argument is now checked in `fortify()`, `get_alt_text()`, 
   `labs()` and several guides (@teunbrand, #3196).
 * `stat_summary_bin()` no longer ignores `width` parameter (@teunbrand, #4647).
-* Added `keep.zeroes` argument to `stat_bin()` (@teunbrand, #3449)
+* Reintroduced `drop` argument to `stat_bin()` (@teunbrand, #3449)
 * (internal) removed barriers for using 2D structures as aesthetics 
   (@teunbrand, #4189).
 * `coord_sf()` no longer errors when dealing with empty graticules (@teunbrand, #6052)

R/bin.R

@@ -227,12 +227,6 @@ bin_out <- function(count = integer(0), x = numeric(0), width = numeric(0),
 
 fix_bin_params = function(params, fun, version) {
 
-  if (!is.null(params$drop)) {
-    args <- paste0(fun, c("(drop)", "(pad)"))
-    deprecate_warn0(version, args[1], args[2])
-    params$drop <- NULL
-  }
-
   if (!is.null(params$origin)) {
     args <- paste0(fun, c("(origin)", "(boundary)"))
     deprecate_warn0(version, args[1], args[2])

R/stat-bin.R

@@ -26,10 +26,11 @@
 #'   or left edges of bins are included in the bin.
 #' @param pad If `TRUE`, adds empty bins at either end of x. This ensures
 #'   frequency polygons touch 0. Defaults to `FALSE`.
-#' @param keep.zeroes Treatment of zero count bins. If `"all"` (default), such
+#' @param drop Treatment of zero count bins. If `"all"` (default), such
 #'   bins are kept as-is. If `"none"`, all zero count bins are filtered out.
 #'   If `"inner"` only zero count bins at the flanks are filtered out, but not
-#'   in the middle.
+#'   in the middle. `TRUE` is shorthand for `"all"` and `FALSE` is shorthand
+#'   for `"none"`.
 #' @eval rd_computed_vars(
 #'   count    = "number of points in bin.",
 #'   density  = "density of points in bin, scaled to integrate to 1.",
@@ -59,7 +60,7 @@ stat_bin <- function(mapping = NULL, data = NULL,
                      closed = c("right", "left"),
                      pad = FALSE,
                      na.rm = FALSE,
-                     keep.zeroes = "all",
+                     drop = "all",
                      orientation = NA,
                      show.legend = NA,
                      inherit.aes = TRUE) {
@@ -82,7 +83,7 @@ stat_bin <- function(mapping = NULL, data = NULL,
       pad = pad,
       na.rm = na.rm,
       orientation = orientation,
-      keep.zeroes = keep.zeroes,
+      drop = drop,
       ...
     )
   )
@@ -95,9 +96,13 @@ stat_bin <- function(mapping = NULL, data = NULL,
 StatBin <- ggproto("StatBin", Stat,
   setup_params = function(self, data, params) {
     params$flipped_aes <- has_flipped_aes(data, params, main_is_orthogonal = FALSE)
-    params$keep.zeroes <- arg_match0(
-      params$keep.zeroes %||% "all",
-      c("all", "none", "inner"), arg_nm = "keep.zeroes"
+
+    if (is.logical(params$drop)) {
+      params$drop <- if (isTRUE(params$drop)) "all" else "none"
+    }
+    params$drop <- arg_match0(
+      params$drop %||% "all",
+      c("all", "none", "inner"), arg_nm = "drop"
     )
 
     has_x <- !(is.null(data$x) && is.null(params$x))
@@ -127,10 +132,10 @@ StatBin <- ggproto("StatBin", Stat,
   compute_group = function(data, scales, binwidth = NULL, bins = NULL,
                            center = NULL, boundary = NULL,
                            closed = c("right", "left"), pad = FALSE,
-                           breaks = NULL, flipped_aes = FALSE, keep.zeroes = "all",
+                           breaks = NULL, flipped_aes = FALSE, drop = "all",
                            # The following arguments are not used, but must
                            # be listed so parameters are computed correctly
-                           origin = NULL, right = NULL, drop = NULL) {
+                           origin = NULL, right = NULL) {
     x <- flipped_names(flipped_aes)$x
     bins <- compute_bins(
       data[[x]], scales[[x]],
@@ -140,7 +145,7 @@ StatBin <- ggproto("StatBin", Stat,
     bins <- bin_vector(data[[x]], bins, weight = data$weight, pad = pad)
 
     keep <- switch(
-      keep.zeroes,
+      drop,
       none  = bins$count != 0,
       inner = inner_runs(bins$count != 0),
       TRUE

R/stat-bin2d.R

@@ -53,8 +53,12 @@ StatBin2d <- ggproto("StatBin2d", Stat,
   required_aes = c("x", "y"),
 
   setup_params = function(self, data, params) {
-    params <- fix_bin_params(params, fun = snake_class(self), version = "3.5.2")
 
+    if (is.character(params$drop)) {
+      params$drop <- !identical(params$drop, "none")
+    }
+
+    params <- fix_bin_params(params, fun = snake_class(self), version = "3.5.2")
     vars <- c("origin", "binwidth", "breaks", "center", "boundary")
     params[vars] <- lapply(params[vars], dual_param)
     params$closed <- dual_param(params$closed, list(x = "right", y = "right"))

tests/testthat/test-stat-bin.R

@@ -118,17 +118,17 @@ test_that("stat_bin() provides width (#3522)", {
   expect_equal(out$xmax - out$xmin, rep(binwidth, 10))
 })
 
-test_that("stat_bin(keep.zeroes) options work as intended", {
+test_that("stat_bin(drop) options work as intended", {
   p <- ggplot(data.frame(x = c(1, 2, 2, 3, 5, 6, 6, 7)), aes(x)) +
     scale_x_continuous(limits = c(-1, 9))
 
-  ld <- layer_data(p + geom_histogram(binwidth = 1, keep.zeroes = "all"))
+  ld <- layer_data(p + geom_histogram(binwidth = 1, drop = "all"))
   expect_equal(ld$x, -1:9)
 
-  ld <- layer_data(p + geom_histogram(binwidth = 1, keep.zeroes = "inner"))
+  ld <- layer_data(p + geom_histogram(binwidth = 1, drop = "inner"))
   expect_equal(ld$x, c(1:7))
 
-  ld <- layer_data(p + geom_histogram(binwidth = 1, keep.zeroes = "none"))
+  ld <- layer_data(p + geom_histogram(binwidth = 1, drop = "none"))
   expect_equal(ld$x, c(1:3, 5:7))
 })