data_rename: mention use of unlist() for named lists

easystats · Jan 3, 2025 · 2b5d0fa · 2b5d0fa
1 parent 416c1b0
commit 2b5d0fa
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/R/data_rename.R b/R/data_rename.R
@@ -46,15 +46,16 @@
 #'
 #' @details
 #' `select` can also be a named character vector. In this case, the names are
-#' used to rename the columns in the output data frame. See 'Examples'.
+#' used to rename the columns in the output data frame. If you have a named
+#' list, use `unlist()` to convert it to a named vector. See 'Examples'.
 #'
 #' @return A modified data frame.
 #'
 #' @examples
 #' # Rename columns
 #' head(data_rename(iris, "Sepal.Length", "length"))
 #'
-#' # use named vector to rename
+#' # Use named vector to rename
 #' head(data_rename(iris, c(length = "Sepal.Length", width = "Sepal.Width")))
 #'
 #' # Change all

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