Deprecate .add argument to group_by()

Fixes #156
tidyverse · Jan 26, 2021 · 7664bd2 · 7664bd2
1 parent 3bba40b
commit 7664bd2
Show file tree

Hide file tree

Showing 7 changed files with 37 additions and 6 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -20,7 +20,8 @@ Depends:
 Imports:
     crayon,
     data.table (>= 1.12.4),
-    dplyr (>= 0.8.1),
+    dplyr (>= 1.0.0),
+    lifecycle,
     rlang,
     tibble,
     tidyselect

diff --git a/NAMESPACE b/NAMESPACE
@@ -118,6 +118,7 @@ importFrom(dplyr,transmute)
 importFrom(dplyr,ungroup)
 importFrom(dplyr,union)
 importFrom(dplyr,union_all)
+importFrom(lifecycle,deprecated)
 importFrom(tibble,as_tibble)
 importFrom(utils,head)
 importFrom(utils,tail)
diff --git a/R/dtplyr-package.R b/R/dtplyr-package.R
@@ -1,5 +1,6 @@
 #' @import rlang
 #' @importFrom data.table data.table as.data.table .SD copy is.data.table
+#' @importFrom lifecycle deprecated
 "_PACKAGE"
 
 #' @export

diff --git a/R/step-group.R b/R/step-group.R
@@ -32,16 +32,25 @@ add_grouping_param <- function(call, step) {
 #' @importFrom dplyr group_by
 #' @rdname single_table
 #' @export
-group_by.dtplyr_step <- function(.data, ..., add = FALSE, arrange = TRUE) {
+group_by.dtplyr_step <- function(.data, ..., .add = FALSE, add = deprecated(), arrange = TRUE) {
   dots <- capture_dots(.data, ...)
 
+  if (lifecycle::is_present(add)) {
+    lifecycle::deprecate_warn(
+      "1.0.0",
+      "dplyr::group_by(add = )",
+      "group_by(.add = )"
+    )
+    .add <- add
+  }
+
   existing <- vapply(dots, is_symbol, logical(1))
   if (!all(existing)) {
     .data <- mutate(.data, !!!dots[!existing])
     dots[!existing] <- syms(names(dots[!existing]))
   }
 
-  groups <- c(if (add) .data$groups, names(dots))
+  groups <- c(if (.add) .data$groups, names(dots))
   arranged <- if (!is.null(.data$arrange)) .data$arrange && arrange else arrange
 
   step_group(.data, groups, arranged)

diff --git a/man/single_table.Rd b/man/single_table.Rd
diff --git a/tests/testthat/_snaps/step-group.md b/tests/testthat/_snaps/step-group.md
@@ -0,0 +1,8 @@
+# can add groups if requested
+
+    Code
+      . <- dt %>% group_by(x) %>% group_by(y, add = TRUE)
+    Warning <lifecycle_warning_deprecated>
+      The `add` argument of `group_by()` is deprecated as of dplyr 1.0.0.
+      Please use the `.add` argument instead.
+
diff --git a/tests/testthat/test-step-group.R b/tests/testthat/test-step-group.R
@@ -7,13 +7,16 @@ test_that("grouping and ungrouping adjust groups field", {
   expect_equal(dt %>% group_by(x) %>% ungroup() %>% .$groups, character())
 })
 
-
 test_that("can add groups if requested", {
   dt <- lazy_dt(data.frame(x = 1:3, y = 1:3), "DT")
   expect_equal(
-    dt %>% group_by(x) %>% group_by(y, add = TRUE) %>% .$groups,
+    dt %>% group_by(x) %>% group_by(y, .add = TRUE) %>% .$groups,
     c("x", "y")
   )
+
+  expect_snapshot({
+    . <- dt %>% group_by(x) %>% group_by(y, add = TRUE)
+  })
 })
 
 test_that("grouping can compute new variables if needed", {