Add rename_with() example of using paste0(recycle0 = TRUE) (#6690)

* Add an example of `recycle0` * NEWS bullet
tidyverse · Feb 7, 2023 · e8702df · e8702df
1 parent 8610ce5
commit e8702df
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 0 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,8 @@
 # dplyr (development version)
 
+* `rename_with()` now includes an example of using `paste0(recycle0 = TRUE)` to
+  correctly handle empty selections (#6688).
+
 # dplyr 1.1.0
 
 ## New features

diff --git a/R/rename.R b/R/rename.R
@@ -44,6 +44,21 @@
 #' rename_with(iris, toupper)
 #' rename_with(iris, toupper, starts_with("Petal"))
 #' rename_with(iris, ~ tolower(gsub(".", "_", .x, fixed = TRUE)))
+#'
+#' @examplesIf getRversion() > "4.0.1"
+#' # If your renaming function uses `paste0()`, make sure to set
+#' # `recycle0 = TRUE` to ensure that empty selections are recycled correctly
+#' try(rename_with(
+#'   iris,
+#'   ~ paste0("prefix_", .x),
+#'   starts_with("nonexistent")
+#' ))
+#'
+#' rename_with(
+#'   iris,
+#'   ~ paste0("prefix_", .x, recycle0 = TRUE),
+#'   starts_with("nonexistent")
+#' )
 #' @export
 rename <- function(.data, ...) {
   UseMethod("rename")

diff --git a/man/rename.Rd b/man/rename.Rd