Deprecate fatten (#6238)

* deprecate fatten

* `fatten` isn't a formal argument to `geom_boxplot()`

* document

* add news bullet

Author: teunbrand

NEWS.md

@@ -1,5 +1,7 @@
 # ggplot2 (development version)
 
+* The `fatten` argument has been deprecated in `geom_boxplot()`, 
+  `geom_crossbar()` and `geom_pointrange()` (@teunbrand, #4881).
 * Axis labels are now preserved better when using `coord_sf(expand = TRUE)` and
   graticule lines are straight but do not meet the edge (@teunbrand, #2985).
 * Attempt to boost detail in `coord_polar()` and `coord_radial()` near the 

R/geom-boxplot.R

@@ -239,6 +239,15 @@ GeomBoxplot <- ggproto("GeomBoxplot", Geom,
   extra_params = c("na.rm", "orientation", "outliers"),
 
   setup_params = function(data, params) {
+    if ("fatten" %in% names(params)) {
+      deprecate_soft0(
+        "3.6.0", "geom_boxplot(fatten)",
+        "geom_boxplot(median.linewidth)"
+      )
+    } else {
+      # For backward compatibility reasons
+      params$fatten <- 2
+    }
     params$flipped_aes <- has_flipped_aes(data, params)
     params
   },

R/geom-crossbar.R

@@ -17,7 +17,7 @@ geom_crossbar <- function(mapping = NULL, data = NULL,
                           box.color         = NULL,
                           box.linetype      = NULL,
                           box.linewidth     = NULL,
-                          fatten = 2.5,
+                          fatten = deprecated(),
                           na.rm = FALSE,
                           orientation = NA,
                           show.legend = NA,
@@ -60,6 +60,15 @@ geom_crossbar <- function(mapping = NULL, data = NULL,
 #' @export
 GeomCrossbar <- ggproto("GeomCrossbar", Geom,
   setup_params = function(data, params) {
+    if (lifecycle::is_present(params$fatten)) {
+      deprecate_soft0(
+        "3.6.0", "geom_crossbar(fatten)",
+        "geom_crossbar(middle.linewidth)"
+      )
+    } else {
+      # For backward compatibility reasons
+      params$fatten <- 2.5
+    }
     GeomErrorbar$setup_params(data, params)
   },
 

R/geom-linerange.R

@@ -6,9 +6,9 @@
 #' @eval rd_orientation()
 #'
 #' @eval rd_aesthetics("geom", "linerange", "Note that `geom_pointrange()` also understands `size` for the size of the points.")
-#' @param fatten A multiplicative factor used to increase the size of the
-#'   middle bar in `geom_crossbar()` and the middle point in
-#'   `geom_pointrange()`.
+#' @param fatten `r lifecycle::badge("deprecated")`  A multiplicative factor
+#'   used to increase the size of the middle bar in `geom_crossbar()` and the
+#'   middle point in `geom_pointrange()`.
 #' @seealso
 #'  [stat_summary()] for examples of these guys in use,
 #'  [geom_smooth()] for continuous analogue

R/geom-pointrange.R

@@ -3,7 +3,7 @@
 geom_pointrange <- function(mapping = NULL, data = NULL,
                             stat = "identity", position = "identity",
                             ...,
-                            fatten = 4,
+                            fatten = deprecated(),
                             na.rm = FALSE,
                             orientation = NA,
                             show.legend = NA,
@@ -42,6 +42,12 @@ GeomPointrange <- ggproto("GeomPointrange", Geom,
   required_aes = c("x", "y", "ymin|xmin", "ymax|xmax"),
 
   setup_params = function(data, params) {
+    if (lifecycle::is_present(params$fatten)) {
+      deprecate_soft0("3.6.0", "geom_pointrange(fatten)", I("the `size` aesthetic"))
+    } else {
+      # For backward compatibility reasons
+      params$fatten <- 4
+    }
     GeomLinerange$setup_params(data, params)
   },