backward compatibility for ggplot_gtable()

Author: teunbrand

NAMESPACE

@@ -57,6 +57,7 @@ S3method(fortify,tbl)
 S3method(fortify,tbl_df)
 S3method(ggplot_add,default)
 S3method(ggplot_build,default)
+S3method(ggplot_gtable,default)
 S3method(grid.draw,absoluteGrob)
 S3method(grobHeight,absoluteGrob)
 S3method(grobHeight,zeroGrob)
@@ -439,6 +440,7 @@ export(ggproto)
 export(ggproto_parent)
 export(ggsave)
 export(ggtitle)
+export(gtable_ggplot)
 export(guide_axis)
 export(guide_axis_logticks)
 export(guide_axis_stack)

R/plot-build.R

@@ -193,6 +193,9 @@ layer_grob <- get_layer_grob
 #' to (e.g.) make the legend box 2 cm wide, or combine multiple plots into
 #' a single display, preserving aspect ratios across the plots.
 #'
+#' The `ggplot_gtable()` function is vestigial and the `gtable_ggplot()` function
+#' should be used instead.
+#'
 #' @seealso
 #' [print.ggplot()] and [benchplot()] for
 #' for functions that contain the complete set of steps for generating
@@ -203,12 +206,12 @@ layer_grob <- get_layer_grob
 #' @keywords internal
 #' @param data plot data generated by [ggplot_build()]
 #' @export
-ggplot_gtable <- S7::new_generic("ggplot_gtable", "data", function(data) {
+gtable_ggplot <- S7::new_generic("gtable_ggplot", "data", function(data) {
   attach_plot_env(data@plot@plot_env)
   S7::S7_dispatch()
 })
 
-S7::method(ggplot_gtable, class_ggplot_built) <- function(data) {
+S7::method(gtable_ggplot, class_ggplot_built) <- function(data) {
   plot <- data@plot
   layout <- data@layout
   data <- data@data
@@ -309,6 +312,18 @@ S7::method(ggplot_gtable, class_ggplot_built) <- function(data) {
   plot_table
 }
 
+# TODO: the S3 generic should be phased out once S7 is adopted more widely
+#' @rdname gtable_ggplot
+#' @export
+ggplot_gtable <- function(plot) {
+  UseMethod("ggplot_gtable")
+}
+
+#' @export
+ggplot_gtable.default <- function(plot) {
+  gtable_ggplot(plot)
+}
+
 #' Generate a ggplot2 plot grob.
 #'
 #' @param x ggplot2 object