annotate() gives warning when passing position or stat (#5746)

* `annotate()` warns about `position` and `stat` args

* add tests

* add news bullet

Author: teunbrand

NEWS.md

@@ -10,6 +10,7 @@
 * Patterns and gradients are now also enabled in `geom_sf()` 
   (@teunbrand, #5716).
 * `stat_bin()` deals with non-finite breaks better (@teunbrand, #5665).
+* `annotate()` now warns about `stat` or `position` arguments (@teunbrand, #5151)
 
 # ggplot2 3.5.0
 

R/annotation.R

@@ -74,12 +74,19 @@ annotate <- function(geom, x = NULL, y = NULL, xmin = NULL, xmax = NULL,
   }
 
   data <- data_frame0(!!!position, .size = n)
+
+  params <- list2(na.rm = na.rm, ...)
+  reject <- intersect(names(params), c("position", "stat"))
+  if (length(reject) > 0) {
+    cli::cli_warn(
+      "{.fn annotate} can't accept {.or {.arg {reject}}} argument{?s}."
+    )
+    params <- params[setdiff(names(params), reject)]
+  }
+
   layer(
     geom = geom,
-    params = list(
-      na.rm = na.rm,
-      ...
-    ),
+    params = params,
     stat = StatIdentity,
     position = PositionIdentity,
     data = data,

tests/testthat/_snaps/annotate.md

@@ -34,3 +34,7 @@
     Using the `size` aesthetic in this geom was deprecated in ggplot2 3.5.0.
     i Please use `linewidth` instead.
 
+# annotate() warns about `stat` or `position` arguments
+
+    `annotate()` can't accept `stat` or `position` arguments.
+

tests/testthat/test-annotate.R

@@ -80,3 +80,9 @@ test_that("annotate() checks aesthetic lengths match", {
 test_that("annotation_logticks warns about deprecated `size` argument", {
   expect_snapshot_warning(annotation_logticks(size = 5))
 })
+
+test_that("annotate() warns about `stat` or `position` arguments", {
+  expect_snapshot_warning(
+    annotate("point", 1:3, 1:3, stat = "density", position = "dodge")
+  )
+})