Boilerplate functions (#6143)

* write boilerplate function

* adopt boilerplate where possible

* write out all non-standard arguments

* automatically fill in parameters

* incorporate small checks

* document

* accept visual snapshots

* Update R/boilerplates.R

Thanks June!

Co-authored-by: June Choe <52832839+yjunechoe@users.noreply.github.com>

* Adopt advice from June

* docfix

* Apply suggestions from code review

Co-authored-by: June Choe <52832839+yjunechoe@users.noreply.github.com>

* ensure `list2()` can be found

* rename `boilerplate()` to `make_constructor()`

* give body pretty braces

* purge unused parameters in `stat_bin()`

* add Stat method for `make_constructor()`

* use the `make_constructor()` for Stats

* revert 4dd78b5 for `layer_sf()` stats

* mechanism to hide internal variables

* document

* make GeomCol parent of `geom_col()` again for error message purposes

* rebalance omissions

* include example of `checks` argument

* Hide origin/right arguments that are deprecated

* avoid arbitrary whitespace changes

* apply boilerplate to `stat_connect()`

* Also boilerplate `stat_manual()`

* boilerplate `geom_text()`

* remove deprecated args

* add news bullet

---------

Co-authored-by: June Choe <52832839+yjunechoe@users.noreply.github.com>

Author: teunbrand

DESCRIPTION

@@ -98,6 +98,9 @@ Collate:
     'geom-.R'
     'annotation-custom.R'
     'annotation-logticks.R'
+    'scale-type.R'
+    'layer.R'
+    'make-constructor.R'
     'geom-polygon.R'
     'geom-map.R'
     'annotation-map.R'
@@ -142,6 +145,7 @@ Collate:
     'geom-col.R'
     'geom-path.R'
     'geom-contour.R'
+    'geom-point.R'
     'geom-count.R'
     'geom-crossbar.R'
     'geom-segment.R'
@@ -160,7 +164,6 @@ Collate:
     'geom-jitter.R'
     'geom-label.R'
     'geom-linerange.R'
-    'geom-point.R'
     'geom-pointrange.R'
     'geom-quantile.R'
     'geom-rug.R'
@@ -186,7 +189,6 @@ Collate:
     'guide-colorbar.R'
     'guide-colorsteps.R'
     'guide-custom.R'
-    'layer.R'
     'guide-none.R'
     'guide-old.R'
     'guides-.R'
@@ -236,7 +238,6 @@ Collate:
     'scale-shape.R'
     'scale-size.R'
     'scale-steps.R'
-    'scale-type.R'
     'scale-view.R'
     'scale-viridis.R'
     'scales-.R'

NAMESPACE

@@ -95,6 +95,8 @@ S3method(limits,character)
 S3method(limits,factor)
 S3method(limits,numeric)
 S3method(makeContext,dotstackGrob)
+S3method(make_constructor,Geom)
+S3method(make_constructor,Stat)
 S3method(merge_element,default)
 S3method(merge_element,element)
 S3method(merge_element,element_blank)
@@ -507,6 +509,7 @@ export(layer_grob)
 export(layer_scales)
 export(layer_sf)
 export(lims)
+export(make_constructor)
 export(map_data)
 export(margin)
 export(margin_auto)

NEWS.md

@@ -1,5 +1,7 @@
 # ggplot2 (development version)
 
+* New `make_constructor()` function that builds a standard constructor for
+  Geom and Stat classes (@teunbrand, #6142).
 * In continuous scales, when `breaks` is a function and `n.breaks` is set, the 
   `n.breaks` will be passed to the `breaks` function. Previously, `n.breaks` 
   only applied to the default break calculation (@teunbrand, #5972)

R/coord-transform.R

@@ -199,7 +199,7 @@ CoordTransform <- ggproto(
 )
 
 # TODO: deprecate this some time in the future
-#' @rdname ggplot2-ggproto
+#' @rdname Coord
 #' @format NULL
 #' @usage NULL
 #' @export

R/geom-bar.R

@@ -1,3 +1,45 @@
+#' @rdname Geom
+#' @format NULL
+#' @usage NULL
+#' @export
+#' @include geom-rect.R
+GeomBar <- ggproto(
+  "GeomBar", GeomRect,
+  required_aes = c("x", "y"),
+
+  # These aes columns are created by setup_data(). They need to be listed here so
+  # that GeomRect$handle_na() properly removes any bars that fall outside the defined
+  # limits, not just those for which x and y are outside the limits
+  non_missing_aes = c("xmin", "xmax", "ymin", "ymax"),
+
+  default_aes = aes(!!!GeomRect$default_aes, width = 0.9),
+
+  setup_params = function(data, params) {
+    params$flipped_aes <- has_flipped_aes(data, params)
+    params
+  },
+
+  extra_params = c("just", "na.rm", "orientation"),
+
+  setup_data = function(self, data, params) {
+    data$flipped_aes <- params$flipped_aes
+    data <- flip_data(data, params$flipped_aes)
+    data <- compute_data_size(
+      data, size = params$width,
+      default = self$default_aes$width, zero = FALSE
+    )
+    data$just <- params$just %||% 0.5
+    data <- transform(data,
+                      ymin = pmin(y, 0), ymax = pmax(y, 0),
+                      xmin = x - width * just, xmax = x + width * (1 - just),
+                      width = NULL, just = NULL
+    )
+    flip_data(data, params$flipped_aes)
+  },
+
+  rename_size = FALSE
+)
+
 #' Bar charts
 #'
 #' There are two types of bar charts: `geom_bar()` and `geom_col()`.
@@ -48,6 +90,8 @@
 #' @param geom,stat Override the default connection between `geom_bar()` and
 #'   `stat_count()`. For more information about overriding these connections,
 #'   see how the [stat][layer_stats] and [geom][layer_geoms] arguments work.
+#' @param lineend Line end style (round, butt, square).
+#' @param linejoin Line join style (round, mitre, bevel).
 #' @examples
 #' # geom_bar is designed to make it easy to create bar charts that show
 #' # counts (or sums of weights)
@@ -92,68 +136,7 @@
 #' ggplot(df, aes(x, y)) + geom_col(just = 0.5)
 #' # Columns begin on the first day of the month
 #' ggplot(df, aes(x, y)) + geom_col(just = 1)
-geom_bar <- function(mapping = NULL, data = NULL,
-                     stat = "count", position = "stack",
-                     ...,
-                     just = 0.5,
-                     na.rm = FALSE,
-                     orientation = NA,
-                     show.legend = NA,
-                     inherit.aes = TRUE) {
-  layer(
-    data = data,
-    mapping = mapping,
-    stat = stat,
-    geom = GeomBar,
-    position = position,
-    show.legend = show.legend,
-    inherit.aes = inherit.aes,
-    params = list2(
-      just = just,
-      na.rm = na.rm,
-      orientation = orientation,
-      ...
-    )
-  )
-}
-
-#' @rdname Geom
-#' @format NULL
-#' @usage NULL
-#' @export
-#' @include geom-rect.R
-GeomBar <- ggproto("GeomBar", GeomRect,
-  required_aes = c("x", "y"),
-
-  # These aes columns are created by setup_data(). They need to be listed here so
-  # that GeomRect$handle_na() properly removes any bars that fall outside the defined
-  # limits, not just those for which x and y are outside the limits
-  non_missing_aes = c("xmin", "xmax", "ymin", "ymax"),
-
-  default_aes = aes(!!!GeomRect$default_aes, width = 0.9),
-
-  setup_params = function(data, params) {
-    params$flipped_aes <- has_flipped_aes(data, params)
-    params
-  },
-
-  extra_params = c("just", "na.rm", "orientation"),
-
-  setup_data = function(self, data, params) {
-    data$flipped_aes <- params$flipped_aes
-    data <- flip_data(data, params$flipped_aes)
-    data <- compute_data_size(
-      data, size = params$width,
-      default = self$default_aes$width, zero = FALSE
-    )
-    data$just <- params$just %||% 0.5
-    data <- transform(data,
-      ymin = pmin(y, 0), ymax = pmax(y, 0),
-      xmin = x - width * just, xmax = x + width * (1 - just),
-      width = NULL, just = NULL
-    )
-    flip_data(data, params$flipped_aes)
-  },
-
-  rename_size = FALSE
+geom_bar <- make_constructor(
+  GeomBar,
+  stat = "count", position = "stack", just = 0.5
 )

R/geom-bin2d.R

@@ -1,6 +1,12 @@
 #' @include geom-tile.R
 NULL
 
+#' @rdname Geom
+#' @format NULL
+#' @usage NULL
+#' @export
+GeomBin2d <- ggproto("GeomBin2d", GeomTile)
+
 #' Heatmap of 2d bin counts
 #'
 #' Divides the plane into rectangles, counts the number of cases in
@@ -17,6 +23,8 @@ NULL
 #'   `geom_bin_2d()` and `stat_bin_2d()`. For more information about overriding
 #'   these connections, see how the [stat][layer_stats] and [geom][layer_geoms]
 #'   arguments work.
+#' @param lineend Line end style (round, butt, square).
+#' @param linejoin Line join style (round, mitre, bevel).
 #' @seealso [stat_bin_hex()] for hexagonal binning
 #' @examples
 #' d <- ggplot(diamonds, aes(x, y)) + xlim(4, 10) + ylim(4, 10)
@@ -29,35 +37,9 @@ NULL
 #'
 #' # Or by specifying the width of the bins
 #' d + geom_bin_2d(binwidth = c(0.1, 0.1))
-geom_bin_2d <- function(mapping = NULL, data = NULL,
-                       stat = "bin2d", position = "identity",
-                       ...,
-                       na.rm = FALSE,
-                       show.legend = NA,
-                       inherit.aes = TRUE) {
-
-  layer(
-    data = data,
-    mapping = mapping,
-    stat = stat,
-    geom = GeomBin2d,
-    position = position,
-    show.legend = show.legend,
-    inherit.aes = inherit.aes,
-    params = list2(
-      na.rm = na.rm,
-      ...
-    )
-  )
-}
+geom_bin_2d <- make_constructor(GeomBin2d, stat = "bin2d")
 
 #' @export
 #' @rdname geom_bin_2d
 #' @usage NULL
 geom_bin2d <- geom_bin_2d
-
-#' @rdname Geom
-#' @format NULL
-#' @usage NULL
-#' @export
-GeomBin2d <- ggproto("GeomBin2d", GeomTile)

R/geom-col.R

@@ -1,33 +1,11 @@
-#' @export
-#' @rdname geom_bar
-geom_col <- function(mapping = NULL, data = NULL,
-                     position = "stack",
-                     ...,
-                     just = 0.5,
-                     na.rm = FALSE,
-                     show.legend = NA,
-                     inherit.aes = TRUE) {
-
-  layer(
-    data = data,
-    mapping = mapping,
-    stat = "identity",
-    geom = GeomCol,
-    position = position,
-    show.legend = show.legend,
-    inherit.aes = inherit.aes,
-    params = list2(
-      just = just,
-      na.rm = na.rm,
-      ...
-    )
-  )
-}
-
 #' @rdname Geom
 #' @format NULL
 #' @usage NULL
 #' @export
 #' @include geom-rect.R
 # TODO: deprecate this
 GeomCol <- ggproto("GeomCol", GeomBar)
+
+#' @export
+#' @rdname geom_bar
+geom_col <- make_constructor(GeomCol, position = "stack", just = 0.5)