remove nudge specific stuff from geom_text()/geom_label()

teunbrand · teunbrand · commit 93d53954e36f · 2024-09-12T13:51:17.000+02:00
diff --git a/R/geom-label.R b/R/geom-label.R
@@ -4,28 +4,16 @@
 #' @param label.r Radius of rounded corners. Defaults to 0.15 lines.
 #' @param label.size Size of label border, in mm.
 geom_label <- function(mapping = NULL, data = NULL,
-                       stat = "identity", position = "identity",
+                       stat = "identity", position = "nudge",
                        ...,
                        parse = FALSE,
-                       nudge_x = 0,
-                       nudge_y = 0,
                        label.padding = unit(0.25, "lines"),
                        label.r = unit(0.15, "lines"),
                        label.size = 0.25,
                        size.unit = "mm",
                        na.rm = FALSE,
                        show.legend = NA,
                        inherit.aes = TRUE) {
-  if (!missing(nudge_x) || !missing(nudge_y)) {
-    if (!missing(position)) {
-      cli::cli_abort(c(
-        "Both {.arg position} and {.arg nudge_x}/{.arg nudge_y} are supplied.",
-        "i" = "Choose one approach to alter the position."
-      ))
-    }
-
-    position <- position_nudge(nudge_x, nudge_y)
-  }
 
   layer(
     data = data,
diff --git a/R/geom-sf.R b/R/geom-sf.R
@@ -313,11 +313,9 @@ geom_sf <- function(mapping = aes(), data = NULL, stat = "sf",
 #' @inheritParams geom_label
 #' @inheritParams stat_sf_coordinates
 geom_sf_label <- function(mapping = aes(), data = NULL,
-                          stat = "sf_coordinates", position = "identity",
+                          stat = "sf_coordinates", position = "nudge",
                           ...,
                           parse = FALSE,
-                          nudge_x = 0,
-                          nudge_y = 0,
                           label.padding = unit(0.25, "lines"),
                           label.r = unit(0.15, "lines"),
                           label.size = 0.25,
@@ -326,17 +324,6 @@ geom_sf_label <- function(mapping = aes(), data = NULL,
                           inherit.aes = TRUE,
                           fun.geometry = NULL) {
 
-  if (!missing(nudge_x) || !missing(nudge_y)) {
-    if (!missing(position)) {
-      cli::cli_abort(c(
-        "Both {.arg position} and {.arg nudge_x}/{.arg nudge_y} are supplied.",
-        "i" = "Only use one approach to alter the position."
-      ))
-    }
-
-    position <- position_nudge(nudge_x, nudge_y)
-  }
-
   layer_sf(
     data = data,
     mapping = mapping,
@@ -362,28 +349,15 @@ geom_sf_label <- function(mapping = aes(), data = NULL,
 #' @inheritParams geom_text
 #' @inheritParams stat_sf_coordinates
 geom_sf_text <- function(mapping = aes(), data = NULL,
-                         stat = "sf_coordinates", position = "identity",
+                         stat = "sf_coordinates", position = "nudge",
                          ...,
                          parse = FALSE,
-                         nudge_x = 0,
-                         nudge_y = 0,
                          check_overlap = FALSE,
                          na.rm = FALSE,
                          show.legend = NA,
                          inherit.aes = TRUE,
                          fun.geometry = NULL) {
 
-  if (!missing(nudge_x) || !missing(nudge_y)) {
-    if (!missing(position)) {
-      cli::cli_abort(c(
-        "Both {.arg position} and {.arg nudge_x}/{.arg nudge_y} are supplied.",
-        "i" = "Only use one approach to alter the position."
-      ))
-    }
-
-    position <- position_nudge(nudge_x, nudge_y)
-  }
-
   layer_sf(
     data = data,
     mapping = mapping,
diff --git a/R/geom-text.R b/R/geom-text.R
@@ -41,19 +41,6 @@
 #' @inheritParams geom_point
 #' @param parse If `TRUE`, the labels will be parsed into expressions and
 #'   displayed as described in `?plotmath`.
-#' @param nudge_x,nudge_y Horizontal and vertical adjustment to nudge labels by.
-#'   Useful for offsetting text from points, particularly on discrete scales.
-#'   Cannot be jointly specified with `position`.
-#' @param position A position adjustment to use on the data for this layer.
-#'   Cannot be jointy specified with `nudge_x` or `nudge_y`. This
-#'   can be used in various ways, including to prevent overplotting and
-#'   improving the display. The `position` argument accepts the following:
-#'   * The result of calling a position function, such as `position_jitter()`.
-#'   * A string naming the position adjustment. To give the position as a
-#'     string, strip the function name of the `position_` prefix. For example,
-#'     to use `position_jitter()`, give the position as `"jitter"`.
-#'   * For more information and other ways to specify the position, see the
-#'     [layer position][layer_positions] documentation.
 #' @param check_overlap If `TRUE`, text that overlaps previous text in the
 #'   same layer will not be plotted. `check_overlap` happens at draw time and in
 #'   the order of the data. Therefore data should be arranged by the label
@@ -166,28 +153,15 @@
 #'   geom_text(aes(label = text), vjust = "inward", hjust = "inward")
 #' }
 geom_text <- function(mapping = NULL, data = NULL,
-                      stat = "identity", position = "identity",
+                      stat = "identity", position = "nudge",
                       ...,
                       parse = FALSE,
-                      nudge_x = 0,
-                      nudge_y = 0,
                       check_overlap = FALSE,
                       size.unit = "mm",
                       na.rm = FALSE,
                       show.legend = NA,
                       inherit.aes = TRUE)
 {
-  if (!missing(nudge_x) || !missing(nudge_y)) {
-    if (!missing(position)) {
-      cli::cli_abort(c(
-        "Both {.arg position} and {.arg nudge_x}/{.arg nudge_y} are supplied.",
-        "i" = "Only use one approach to alter the position."
-      ))
-    }
-
-    position <- position_nudge(nudge_x, nudge_y)
-  }
-
   layer(
     data = data,
     mapping = mapping,
diff --git a/tests/testthat/_snaps/geom-label.md b/tests/testthat/_snaps/geom-label.md
@@ -1,7 +1,6 @@
 # geom_label() throws meaningful errors
 
-    Both `position` and `nudge_x`/`nudge_y` are supplied.
-    i Choose one approach to alter the position.
+    Ignoring unknown parameters: `nudge_x`
 
 ---
 
diff --git a/tests/testthat/_snaps/geom-sf.md b/tests/testthat/_snaps/geom-sf.md
@@ -7,13 +7,11 @@
 
 ---
 
-    Both `position` and `nudge_x`/`nudge_y` are supplied.
-    i Only use one approach to alter the position.
+    Ignoring unknown parameters: `nudge_x`
 
 ---
 
-    Both `position` and `nudge_x`/`nudge_y` are supplied.
-    i Only use one approach to alter the position.
+    Ignoring unknown parameters: `nudge_x`
 
 ---
 
diff --git a/tests/testthat/_snaps/geom-text.md b/tests/testthat/_snaps/geom-text.md
@@ -1,5 +1,4 @@
 # geom_text() checks input
 
-    Both `position` and `nudge_x`/`nudge_y` are supplied.
-    i Only use one approach to alter the position.
+    Ignoring unknown parameters: `nudge_x`
 
diff --git a/tests/testthat/_snaps/prohibited-functions.md b/tests/testthat/_snaps/prohibited-functions.md
@@ -43,17 +43,11 @@
       $geom_density_2d_filled
       [1] "contour_var"
       
-      $geom_label
-      [1] "nudge_x" "nudge_y"
-      
-      $geom_sf_label
-      [1] "nudge_x" "nudge_y"
-      
       $geom_sf_text
-      [1] "nudge_x"       "nudge_y"       "check_overlap"
+      [1] "check_overlap"
       
       $geom_text
-      [1] "nudge_x"       "nudge_y"       "check_overlap"
+      [1] "check_overlap"
       
       $geom_violin
       [1] "draw_quantiles"
diff --git a/tests/testthat/test-geom-label.R b/tests/testthat/test-geom-label.R
@@ -1,5 +1,5 @@
 test_that("geom_label() throws meaningful errors", {
-  expect_snapshot_error(geom_label(position = "jitter", nudge_x = 0.5))
+  expect_snapshot_warning(geom_label(position = "jitter", nudge_x = 0.5))
   expect_snapshot_error(labelGrob(label = 1:3))
 })
 
diff --git a/tests/testthat/test-geom-sf.R b/tests/testthat/test-geom-sf.R
@@ -140,8 +140,8 @@ test_that("errors are correctly triggered", {
   )
   p <- ggplot(pts) + geom_sf() + coord_cartesian()
   expect_snapshot_error(ggplotGrob(p))
-  expect_snapshot_error(geom_sf_label(position = "jitter", nudge_x = 0.5))
-  expect_snapshot_error(geom_sf_text(position = "jitter", nudge_x = 0.5))
+  expect_snapshot_warning(geom_sf_label(position = "jitter", nudge_x = 0.5))
+  expect_snapshot_warning(geom_sf_text(position = "jitter", nudge_x = 0.5))
 
   # #5204: missing linewidth should be dropped
   pts <- sf::st_sf(
diff --git a/tests/testthat/test-geom-text.R b/tests/testthat/test-geom-text.R
@@ -1,5 +1,5 @@
 test_that("geom_text() checks input", {
-  expect_snapshot_error(geom_text(position = "jitter", nudge_x = 0.5))
+  expect_snapshot_warning(geom_text(position = "jitter", nudge_x = 0.5))
 })
 
 test_that("geom_text() drops missing angles", {
