rename boilerplate() to make_constructor()

teunbrand · teunbrand · commit 8c33474bc286 · 2024-10-22T11:32:28.000+02:00
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -98,7 +98,7 @@ Collate:
     'annotation-logticks.R'
     'scale-type.R'
     'layer.R'
-    'boilerplates.R'
+    'make-constructor.R'
     'geom-polygon.R'
     'geom-map.R'
     'annotation-map.R'
diff --git a/NAMESPACE b/NAMESPACE
@@ -16,7 +16,6 @@ S3method(as.data.frame,mapped_discrete)
 S3method(as.list,ggproto)
 S3method(autolayer,default)
 S3method(autoplot,default)
-S3method(boilerplate,Geom)
 S3method(c,mapped_discrete)
 S3method(drawDetails,zeroGrob)
 S3method(element_grob,element_blank)
@@ -92,6 +91,7 @@ S3method(limits,character)
 S3method(limits,factor)
 S3method(limits,numeric)
 S3method(makeContext,dotstackGrob)
+S3method(make_constructor,Geom)
 S3method(merge_element,default)
 S3method(merge_element,element)
 S3method(merge_element,element_blank)
@@ -298,7 +298,6 @@ export(autolayer)
 export(autoplot)
 export(benchplot)
 export(binned_scale)
-export(boilerplate)
 export(borders)
 export(calc_element)
 export(check_device)
@@ -492,6 +491,7 @@ export(layer_grob)
 export(layer_scales)
 export(layer_sf)
 export(lims)
+export(make_constructor)
 export(map_data)
 export(margin)
 export(max_height)
diff --git a/R/geom-bar.R b/R/geom-bar.R
@@ -136,4 +136,7 @@ GeomBar <- ggproto("GeomBar", GeomRect,
 #' 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 <- boilerplate(GeomBar, stat = "count", position = "stack", just = 0.5)
+geom_bar <- make_constructor(
+  GeomBar,
+  stat = "count", position = "stack", just = 0.5
+)
diff --git a/R/geom-bin2d.R b/R/geom-bin2d.R
@@ -31,7 +31,7 @@ NULL
 #'
 #' # Or by specifying the width of the bins
 #' d + geom_bin_2d(binwidth = c(0.1, 0.1))
-geom_bin_2d <- boilerplate(GeomTile, stat = "bin2d")
+geom_bin_2d <- make_constructor(GeomTile, stat = "bin2d")
 
 #' @export
 #' @rdname geom_bin_2d
diff --git a/R/geom-col.R b/R/geom-col.R
@@ -1,6 +1,6 @@
 #' @export
 #' @rdname geom_bar
-geom_col <- boilerplate(GeomBar, position = "stack", just = 0.5)
+geom_col <- make_constructor(GeomBar, position = "stack", just = 0.5)
 
 #' @rdname ggplot2-ggproto
 #' @format NULL
diff --git a/R/geom-contour.R b/R/geom-contour.R
@@ -83,15 +83,15 @@ GeomContourFilled <- ggproto("GeomContourFilled", GeomPolygon)
 #' v + geom_raster(aes(fill = density)) +
 #'   geom_contour(colour = "white")
 #' }
-geom_contour <- boilerplate(
+geom_contour <- make_constructor(
   GeomContour, stat = "contour",
   # Passed to contour stat:
   bins = NULL, binwidth = NULL, breaks = NULL
 )
 
 #' @rdname geom_contour
 #' @export
-geom_contour_filled <- boilerplate(
+geom_contour_filled <- make_constructor(
   GeomContourFilled, stat = "contour_filled",
   # Passed to contour_filled stat:
   bins = NULL, binwidth = NULL, breaks = NULL
diff --git a/R/geom-count.R b/R/geom-count.R
@@ -46,4 +46,4 @@ NULL
 #'   scale_size_area(max_size = 10)
 #' d + geom_count(aes(size = after_stat(prop), group = clarity)) +
 #'   scale_size_area(max_size = 10)
-geom_count <- boilerplate(GeomPoint, stat = "sum")
+geom_count <- make_constructor(GeomPoint, stat = "sum")
diff --git a/R/geom-crossbar.R b/R/geom-crossbar.R
@@ -93,4 +93,4 @@ GeomCrossbar <- ggproto("GeomCrossbar", Geom,
 
 #' @export
 #' @rdname geom_linerange
-geom_crossbar <- boilerplate(GeomCrossbar)
+geom_crossbar <- make_constructor(GeomCrossbar)
diff --git a/R/geom-curve.R b/R/geom-curve.R
@@ -47,4 +47,4 @@ GeomCurve <- ggproto("GeomCurve", GeomSegment,
 #' @inheritParams grid::curveGrob
 #' @export
 #' @rdname geom_segment
-geom_curve <- boilerplate(GeomCurve)
+geom_curve <- make_constructor(GeomCurve)
diff --git a/R/geom-density.R b/R/geom-density.R
@@ -72,7 +72,7 @@ GeomDensity <- ggproto(
 #' ggplot(diamonds, aes(carat, after_stat(count), fill = cut)) +
 #'   geom_density(position = "fill")
 #' }
-geom_density <- boilerplate(
+geom_density <- make_constructor(
   GeomDensity, stat = "density",
   checks = exprs(
     outline.type <- arg_match0(outline.type, c("both", "upper", "lower", "full"))
diff --git a/R/geom-errorbar.R b/R/geom-errorbar.R
@@ -58,4 +58,4 @@ GeomErrorbar <- ggproto("GeomErrorbar", Geom,
 
 #' @export
 #' @rdname geom_linerange
-geom_errorbar <- boilerplate(GeomErrorbar, orientation = NA)
+geom_errorbar <- make_constructor(GeomErrorbar, orientation = NA)
diff --git a/R/geom-errorbarh.R b/R/geom-errorbarh.R
@@ -69,4 +69,4 @@ GeomErrorbarh <- ggproto("GeomErrorbarh", Geom,
 #' p +
 #'   geom_point() +
 #'   geom_errorbarh(aes(xmax = resp + se, xmin = resp - se, height = .2))
-geom_errorbarh <- boilerplate(GeomErrorbarh)
+geom_errorbarh <- make_constructor(GeomErrorbarh)
diff --git a/R/geom-function.R b/R/geom-function.R
@@ -85,7 +85,7 @@ GeomFunction <- ggproto("GeomFunction", GeomPath,
 #' geom_function(fun = dnorm, colour = "red", xlim=c(-7, 7))
 #'
 #' @export
-geom_function <- boilerplate(
+geom_function <- make_constructor(
   GeomFunction, stat = "function",
   checks = exprs(data <- data %||% ensure_nonempty_data)
 )
diff --git a/R/geom-hex.R b/R/geom-hex.R
@@ -100,4 +100,4 @@ GeomHex <- ggproto("GeomHex", Geom,
 #' d + geom_hex(binwidth = c(1, 1000))
 #' d + geom_hex(binwidth = c(.1, 500))
 #' }
-geom_hex <- boilerplate(GeomHex, stat = 'binhex')
+geom_hex <- make_constructor(GeomHex, stat = 'binhex')
diff --git a/R/geom-histogram.R b/R/geom-histogram.R
@@ -115,7 +115,7 @@
 #' ggplot(economics_long, aes(value)) +
 #'   facet_wrap(~variable, scales = 'free_x') +
 #'   geom_histogram(binwidth = function(x) 2 * IQR(x) / (length(x)^(1/3)))
-geom_histogram <- boilerplate(
+geom_histogram <- make_constructor(
   GeomBar, stat = "bin", position = "stack",
   # Passed to bin stat:
   binwidth = NULL, bins = NULL, orientation = NA
diff --git a/R/geom-linerange.R b/R/geom-linerange.R
@@ -109,4 +109,4 @@ GeomLinerange <- ggproto(
 #'   aes(ymin = lower, ymax = upper),
 #'   position = position_dodge2(width = 0.5, padding = 0.5)
 #' )
-geom_linerange <- boilerplate(GeomLinerange, orientation = NA)
+geom_linerange <- make_constructor(GeomLinerange, orientation = NA)
diff --git a/R/geom-path.R b/R/geom-path.R
@@ -266,18 +266,18 @@ GeomStep <- ggproto(
 #' # But this doesn't
 #' should_stop(p + geom_line(aes(colour = x), linetype=2))
 #' }
-geom_path <- boilerplate(GeomPath)
+geom_path <- make_constructor(GeomPath)
 
 #' @export
 #' @rdname geom_path
-geom_line <- boilerplate(GeomLine, orientation = NA)
+geom_line <- make_constructor(GeomLine, orientation = NA)
 
 #' @param direction direction of stairs: 'vh' for vertical then horizontal,
 #'   'hv' for horizontal then vertical, or 'mid' for step half-way between
 #'   adjacent x-values.
 #' @export
 #' @rdname geom_path
-geom_step <- boilerplate(GeomStep, orientation = NA)
+geom_step <- make_constructor(GeomStep, orientation = NA)
 
 # Trim false values from left and right: keep all values from
 # first TRUE to last TRUE
diff --git a/R/geom-point.R b/R/geom-point.R
@@ -142,7 +142,7 @@ GeomPoint <- ggproto("GeomPoint", Geom,
 #' ggplot(mtcars2, aes(wt, mpg)) +
 #'   geom_point(na.rm = TRUE)
 #' }
-geom_point <- boilerplate(GeomPoint)
+geom_point <- make_constructor(GeomPoint)
 
 #' Translating shape strings
 #'
diff --git a/R/geom-pointrange.R b/R/geom-pointrange.R
@@ -47,4 +47,4 @@ GeomPointrange <- ggproto("GeomPointrange", Geom,
 
 #' @export
 #' @rdname geom_linerange
-geom_pointrange <- boilerplate(GeomPointrange, orientation = NA)
+geom_pointrange <- make_constructor(GeomPointrange, orientation = NA)
diff --git a/R/geom-polygon.R b/R/geom-polygon.R
@@ -1,4 +1,4 @@
-#' @include boilerplates.R
+#' @include make-constructor.R
 NULL
 
 #' @rdname ggplot2-ggproto
@@ -176,7 +176,7 @@ GeomPolygon <- ggproto("GeomPolygon", Geom,
 #'     geom_polygon(aes(fill = value, group = id, subgroup = subid))
 #'   p
 #' }
-geom_polygon <- boilerplate(GeomPolygon)
+geom_polygon <- make_constructor(GeomPolygon)
 
 # Assigning pathGrob in .onLoad ensures that packages that subclass GeomPolygon
 # do not install with error `possible error in 'pathGrob(munched$x, munched$y, ':
diff --git a/R/geom-quantile.R b/R/geom-quantile.R
@@ -44,4 +44,4 @@ GeomQuantile <- ggproto(
 #'
 #' # Set aesthetics to fixed value
 #' m + geom_quantile(colour = "red", linewidth = 2, alpha = 0.5)
-geom_quantile <- boilerplate(GeomQuantile, stat = "quantile")
+geom_quantile <- make_constructor(GeomQuantile, stat = "quantile")
diff --git a/R/geom-raster.R b/R/geom-raster.R
@@ -96,7 +96,7 @@ GeomRaster <- ggproto("GeomRaster", Geom,
 #'   for both, centering each pixel over its data location.
 #' @param interpolate If `TRUE` interpolate linearly, if `FALSE`
 #'   (the default) don't interpolate.
-geom_raster <- boilerplate(
+geom_raster <- make_constructor(
   GeomRaster,
   checks = exprs(
     check_number_decimal(hjust),
diff --git a/R/geom-rect.R b/R/geom-rect.R
@@ -86,7 +86,7 @@ GeomRect <- ggproto("GeomRect", Geom,
 
 #' @export
 #' @rdname geom_tile
-geom_rect <- boilerplate(GeomRect)
+geom_rect <- make_constructor(GeomRect)
 
 resolve_rect <- function(min = NULL, max = NULL, center = NULL, length = NULL,
                          fun, type) {
diff --git a/R/geom-ribbon.R b/R/geom-ribbon.R
@@ -270,7 +270,7 @@ GeomArea <- ggproto("GeomArea", GeomRibbon,
 #' ggplot(df, aes(x, y, fill = g)) +
 #'   geom_area(stat = "identity")
 #'
-geom_ribbon <- boilerplate(
+geom_ribbon <- make_constructor(
   GeomRibbon, orientation = NA,
   checks = exprs(
     outline.type <- arg_match0(outline.type, c("both", "upper", "lower", "full"))
@@ -279,7 +279,7 @@ geom_ribbon <- boilerplate(
 
 #' @rdname geom_ribbon
 #' @export
-geom_area <- boilerplate(
+geom_area <- make_constructor(
   GeomArea, stat = "align", position = "stack",
   orientation = NA, outline.type = "upper",
   checks = exprs(
diff --git a/R/geom-rug.R b/R/geom-rug.R
@@ -181,4 +181,4 @@ GeomRug <- ggproto("GeomRug", Geom,
 #' p +
 #'   geom_rug(length = unit(0.05, "npc")) +
 #'   scale_y_continuous(expand = c(0.1, 0.1))
-geom_rug <- boilerplate(GeomRug)
+geom_rug <- make_constructor(GeomRug)
diff --git a/R/geom-segment.R b/R/geom-segment.R
@@ -128,4 +128,4 @@ GeomSegment <- ggproto("GeomSegment", Geom,
 #'
 #' ggplot(counts, aes(x, Freq)) +
 #'   geom_segment(aes(xend = x, yend = 0), linewidth = 10, lineend = "butt")
-geom_segment <- boilerplate(GeomSegment)
+geom_segment <- make_constructor(GeomSegment)
diff --git a/R/geom-spoke.R b/R/geom-spoke.R
@@ -40,7 +40,7 @@ GeomSpoke <- ggproto(
 #' ggplot(df, aes(x, y)) +
 #'   geom_point() +
 #'   geom_spoke(aes(angle = angle, radius = speed))
-geom_spoke <- boilerplate(GeomSpoke)
+geom_spoke <- make_constructor(GeomSpoke)
 
 #' @export
 #' @rdname geom_spoke
diff --git a/R/geom-tile.R b/R/geom-tile.R
@@ -117,4 +117,4 @@ GeomTile <- ggproto("GeomTile", GeomRect,
 #'     position = "identity"
 #'   )
 #' }
-geom_tile <- boilerplate(GeomTile)
+geom_tile <- make_constructor(GeomTile)
diff --git a/R/geom-violin.R b/R/geom-violin.R
@@ -180,7 +180,7 @@ GeomViolin <- ggproto("GeomViolin", Geom,
 #'   geom_violin(aes(group = cut_width(year, 10)), scale = "width")
 #' }
 #' }
-geom_violin <- boilerplate(
+geom_violin <- make_constructor(
   GeomViolin, stat = "ydensity", position = "dodge",
   # arguments passed to ydensity stat:
   trim = TRUE, bounds = c(-Inf, Inf), scale = "area"
diff --git a/R/make-constructor.R b/R/make-constructor.R
@@ -4,8 +4,9 @@ NULL
 
 #' Produce boilerplate constructors
 #'
-#' The `boilerplate()` functions sets up a user-facing constructor for ggproto
-#' classes. Currently, `boilerplate()` is implemented for `Geom` classes.
+#' The `make_constructor()` functions sets up a user-facing constructor for
+#' ggproto classes. Currently, `make_constructor()` is implemented for
+#' `Geom` classes.
 #'
 #' @param x An object to setup a constructor for.
 #' @param ... Name-value pairs to use as additional arguments in the
@@ -27,7 +28,7 @@ NULL
 #'   }
 #' )
 #' # Creating a constructor
-#' geom_test <- boilerplate(GeomTest)
+#' geom_test <- make_constructor(GeomTest)
 #'
 #' # Note that `grob` is automatically an argument to the function
 #' names(formals(geom_test))
@@ -37,13 +38,13 @@ NULL
 #' p <- ggplot(mtcars, aes(disp, mpg))
 #' p + geom_test()
 #' p + geom_test(grob = grid::circleGrob())
-boilerplate <- function(x, ...) {
-  UseMethod("boilerplate")
+make_constructor <- function(x, ...) {
+  UseMethod("make_constructor")
 }
 
 #' @export
-#' @rdname boilerplate
-boilerplate.Geom <- function(x, ..., checks = NULL, env = caller_env()) {
+#' @rdname make_constructor
+make_constructor.Geom <- function(x, ..., checks = NULL, env = caller_env()) {
 
   # Check that we can independently find the geom
   geom <- gsub("^geom_", "", snake_class(x))
diff --git a/man/make_constructor.Rd b/man/make_constructor.Rd
