Add gradethis_equal() method for ggplot objects (#37)

Co-authored-by: rossellhayes <[email protected]>

.github/workflows/R-CMD-check.yaml

@@ -29,12 +29,12 @@ jobs:
           - {os: windows-latest, r: '3.6'}
 
           # Use older ubuntu to maximise backward compatibility
-          - {os: ubuntu-18.04,   r: 'devel', http-user-agent: 'release'}
-          - {os: ubuntu-18.04,   r: 'release'}
-          - {os: ubuntu-18.04,   r: 'oldrel-1'}
-          - {os: ubuntu-18.04,   r: 'oldrel-2'}
-          - {os: ubuntu-18.04,   r: 'oldrel-3'}
-          - {os: ubuntu-18.04,   r: 'oldrel-4'}
+          - {os: ubuntu-20.04,   r: 'devel', http-user-agent: 'release'}
+          - {os: ubuntu-20.04,   r: 'release'}
+          - {os: ubuntu-20.04,   r: 'oldrel-1'}
+          - {os: ubuntu-20.04,   r: 'oldrel-2'}
+          - {os: ubuntu-20.04,   r: 'oldrel-3'}
+          - {os: ubuntu-20.04,   r: 'oldrel-4'}
 
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}

.lintr

@@ -1,8 +1,8 @@
-linters: with_defaults(
+linters: linters_with_defaults(
     line_length_linter(120),
     T_and_F_symbol_linter,
     absolute_path_linter,
     nonportable_path_linter,
-    semicolon_terminator_linter,
+    semicolon_linter,
     undesirable_operator_linter
   )

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: ggcheck
 Title: Inspect 'ggplot2' Plots for Automated Grading in Learning Exercises
-Version: 0.0.4
+Version: 0.0.5
 Authors@R: c(
     person("Garrick", "Aden-Buie", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0002-7111-0077")),
@@ -23,7 +23,7 @@ URL: https://github.com/rstudio/ggcheck
 BugReports: https://github.com/rstudio/ggcheck/issues
 Imports: 
     ggplot2,
-    gradethis (>= 0.2.4.9000),
+    gradethis (>= 0.2.12.9004),
     purrr,
     rlang,
     utils
@@ -36,4 +36,4 @@ Config/Needs/website: pkgdown, tidyverse/tidytemplate
 Config/testthat/edition: 3
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.1.2
+RoxygenNote: 7.2.3

NAMESPACE

@@ -4,6 +4,7 @@ S3method(get_data,ggplot)
 S3method(get_data,layer_to_check)
 S3method(get_mappings,ggplot)
 S3method(get_mappings,layer_to_check)
+S3method(gradethis_equal,ggplot)
 export(.result)
 export(default_label)
 export(default_param)
@@ -45,3 +46,4 @@ export(uses_stat_param)
 export(uses_stats)
 importFrom(gradethis,.result)
 importFrom(gradethis,fail)
+importFrom(gradethis,gradethis_equal)

NEWS.md

@@ -1,4 +1,6 @@
-<!-- NEWS.md is maintained by https://cynkra.github.io/fledge, do not edit -->
+# ggcheck 0.0.5
+
+* Add `gradethis_equal()` method for `ggplot` objects (#37).
 
 # ggcheck 0.0.4 (2022-04-14)
 

R/geoms.R

@@ -1,4 +1,3 @@
-
 #' List the geoms used by a plot
 #'
 #' \code{get_geoms} returns a vector of geom names, written as character

R/gradethis_equal.R

@@ -0,0 +1,25 @@
+#' Compare two `ggplot`s to check whether they are equal
+#'
+#' @param x,y Two `ggplot` objects to compare
+#' @param ... Unused
+#'
+#' @seealso [gradethis::gradethis_equal()] for the generic function.
+#' @inherit gradethis::gradethis_equal return
+#' @importFrom gradethis gradethis_equal
+#' @export
+#'
+#' @examples
+#' library(ggplot2)
+#' library(ggcheck)
+#' library(gradethis)
+#'
+#' cty_plot <- ggplot(mpg, aes(x = displ, y = cty)) + geom_point()
+#' hwy_plot <- ggplot(mpg, aes(x = displ, y = cty)) + geom_point()
+#'
+#' gradethis_equal(cty_plot, hwy_plot)
+#' gradethis_equal(cty_plot, cty_plot)
+gradethis_equal.ggplot <- function(x, y, ...) {
+  try(ggplot2::ggplot_build(x), silent = TRUE)
+  try(ggplot2::ggplot_build(y), silent = TRUE)
+  NextMethod()
+}

R/layers.R

@@ -1,4 +1,3 @@
-
 #' How many layers are in a plot?
 #'
 #' @param p A ggplot object

R/stats.R

@@ -1,4 +1,3 @@
-
 #' List the stats used by a plot
 #'
 #' \code{get_stats} returns a vector of stats names, written as character

R/utils.R

@@ -1,4 +1,3 @@
-
 # ggplot2 default mappings from a `geom_` function suffix to geom and stat class names when
 # creating a layer using a `geom_` function.
 # NOTE: this could be dynamically generated as well but would require extra dependency of {sf} package

README.md

@@ -48,7 +48,7 @@ p <-
   geom_smooth(se = FALSE, method = "lm")
 
 p
-#> `geom_smooth()` using formula 'y ~ x'
+#> `geom_smooth()` using formula = 'y ~ x'
 ```
 
 <img src="man/figures/README-expected-plot-1.png" width="100%" />

pkgdown/_pkgdown.yml

@@ -76,3 +76,4 @@ reference:
   - get_default_labels
   - get_default_params
   - default_label
+  - gradethis_equal.ggplot