Update to - rather than _

NEWS.md

@@ -17,21 +17,21 @@
 
   * The mutating joins gain a new `relationship` argument, allowing you to
     enforce one of the following relationship constraints between the keys of
-    `x` and `y`: `"none"`, `"one_to_one"`, `"one_to_many"`, `"many_to_one"`,
-    `"many_to_many"`, or `"warn_many_to_many"`.
+    `x` and `y`: `"none"`, `"one-to-one"`, `"one-to-many"`, `"many-to-one"`,
+    `"many-to-many"`, or `"warn-many-to-many"`.
 
-    For example, `"many_to_one"` enforces that each row in `x` can match at
+    For example, `"many-to-one"` enforces that each row in `x` can match at
     most 1 row in `y`. If a row in `x` matches >1 rows in `y`, an error is
     thrown. This option serves as the replacement for `multiple = "error"`.
 
-    For equality joins, `relationship` defaults to `"warn_many_to_many"` to
+    For equality joins, `relationship` defaults to `"warn-many-to-many"` to
     warn if an unexpected many-to-many relationship is detected, and otherwise
     defaults to `"none"` for inequality, rolling, and overlap joins.
 
   This change unfortunately does mean that if you have set `multiple = "all"` to
   avoid a warning and you happened to be doing a many-to-many style join, then
   you will need to replace `multiple = "all"` with
-  `relationship = "many_to_many"` to silence the new warning, but we believe
+  `relationship = "many-to-many"` to silence the new warning, but we believe
   this should be rare since many-to-many relationships are fairly uncommon.
 
 * `pick()` now returns a 1 row, 0 column tibble when `...` evaluates to an

R/join-rows.R

@@ -222,7 +222,7 @@ rethrow_warning_join_relationship_many_to_many <- function(cnd, call) {
       i = glue("Row {j} of `y` matches multiple rows in `x`."),
       i = paste0(
         "If a many-to-many relationship is expected, ",
-        "set `relationship = \"many_to_many\"` to silence this warning."
+        "set `relationship = \"many-to-many\"` to silence this warning."
       )
     ),
     class = "dplyr_warning_join_relationship_many_to_many",
@@ -377,7 +377,7 @@ standardise_join_relationship <- function(relationship, condition, user_env) {
   # - Inequality and overlap joins often generate many-to-many relationships
   #   by nature
   # - Rolling joins are a little trickier, but we've decided that not warning is
-  #   probably easier to explain. `relationship = "many_to_one"` can always be
+  #   probably easier to explain. `relationship = "many-to-one"` can always be
   #   used explicitly as needed.
   any_inequality <- any(condition != "==")
 
@@ -388,7 +388,7 @@ standardise_join_relationship <- function(relationship, condition, user_env) {
     # to `relationship` to silence it
     "none"
   } else {
-    "warn_many_to_many"
+    "warn-many-to-many"
   }
 }
 
@@ -400,7 +400,7 @@ warn_join_multiple <- function(what, user_env = caller_env(2)) {
   lifecycle::deprecate_warn(
     when = "1.1.1",
     what = I(what),
-    with = I('`relationship = "many_to_one"`'),
+    with = I('`relationship = "many-to-one"`'),
     user_env = user_env,
     always = TRUE
   )

R/join.R

@@ -41,7 +41,7 @@
 #' rows returned from the join.
 #'
 #' If a many-to-many relationship is expected, silence this warning by
-#' explicitly setting `relationship = "many_to_many"`.
+#' explicitly setting `relationship = "many-to-many"`.
 #'
 #' In production code, it is best to preemptively set `relationship` to whatever
 #' relationship you expect to exist between the keys of `x` and `y`, as this
@@ -55,7 +55,7 @@
 #'
 #' Rolling joins don't warn on many-to-many relationships either, but many
 #' rolling joins follow a many-to-one relationship, so it is often useful to
-#' set `relationship = "many_to_one"` to enforce this.
+#' set `relationship = "many-to-one"` to enforce this.
 #'
 #' Note that in SQL, most database providers won't let you specify a
 #' many-to-many relationship between two tables, instead requiring that you
@@ -171,32 +171,32 @@
 #'   invalidated, an error is thrown.
 #'
 #'   - `NULL`, the default, chooses:
-#'     - `"warn_many_to_many"` for equality joins
+#'     - `"warn-many-to-many"` for equality joins
 #'     - `"none"` for inequality joins, rolling joins, and overlap joins
 #'
 #'     See the _Many-to-many relationships_ section for more details.
 #'
 #'   - `"none"` doesn't perform any relationship checks.
 #'
-#'   - `"one_to_one"` expects:
+#'   - `"one-to-one"` expects:
 #'     - Each row in `x` matches at most 1 row in `y`.
 #'     - Each row in `y` matches at most 1 row in `x`.
 #'
-#'   - `"one_to_many"` expects:
+#'   - `"one-to-many"` expects:
 #'     - Each row in `y` matches at most 1 row in `x`.
 #'
-#'   - `"many_to_one"` expects:
+#'   - `"many-to-one"` expects:
 #'     - Each row in `x` matches at most 1 row in `y`.
 #'
-#'   - `"many_to_many"` doesn't perform any relationship checks, and is
+#'   - `"many-to-many"` doesn't perform any relationship checks, and is
 #'     identical to `"none"`, but is provided to allow you to be explicit about
 #'     this relationship if you know it exists.
 #'
-#'   - `"warn_many_to_many"` doesn't assume there is any known relationship, but
+#'   - `"warn-many-to-many"` doesn't assume there is any known relationship, but
 #'     will warn if `x` and `y` have a many-to-many relationship
 #'     (which is typically unexpected), encouraging you to either take a closer
 #'     look at your inputs or make this relationship explicit by specifying
-#'     `"many_to_many"`.
+#'     `"many-to-many"`.
 #'
 #'   `relationship` doesn't handle cases where there are zero matches. For that,
 #'   see `unmatched`.
@@ -232,8 +232,8 @@
 #' df3 %>% left_join(df2)
 #'
 #' # In the rare case where a many-to-many relationship is expected, set
-#' # `relationship = "many_to_many"` to silence this warning
-#' df3 %>% left_join(df2, relationship = "many_to_many")
+#' # `relationship = "many-to-many"` to silence this warning
+#' df3 %>% left_join(df2, relationship = "many-to-many")
 #'
 #' # Use `join_by()` with a condition other than `==` to perform an inequality
 #' # join. Here we match on every instance where `df1$x > df2$x`.

tests/testthat/_snaps/join-rows.md

@@ -7,7 +7,7 @@
       Detected an unexpected many-to-many relationship between `x` and `y`.
       i Row 1 of `x` matches multiple rows in `y`.
       i Row 1 of `y` matches multiple rows in `x`.
-      i If a many-to-many relationship is expected, set `relationship = "many_to_many"` to silence this warning.
+      i If a many-to-many relationship is expected, set `relationship = "many-to-many"` to silence this warning.
 
 # join_rows() allows `unmatched` to be specified independently for inner joins
 
@@ -32,7 +32,7 @@
 # join_rows() gives meaningful one-to-one errors
 
     Code
-      join_rows(1, c(1, 1), relationship = "one_to_one")
+      join_rows(1, c(1, 1), relationship = "one-to-one")
     Condition
       Error:
       ! Each row in `x` must match at most 1 row in `y`.
@@ -41,7 +41,7 @@
 ---
 
     Code
-      join_rows(c(1, 1), 1, relationship = "one_to_one")
+      join_rows(c(1, 1), 1, relationship = "one-to-one")
     Condition
       Error:
       ! Each row in `y` must match at most 1 row in `x`.
@@ -50,7 +50,7 @@
 # join_rows() gives meaningful one-to-many errors
 
     Code
-      join_rows(c(1, 1), 1, relationship = "one_to_many")
+      join_rows(c(1, 1), 1, relationship = "one-to-many")
     Condition
       Error:
       ! Each row in `y` must match at most 1 row in `x`.
@@ -59,7 +59,7 @@
 # join_rows() gives meaningful many-to-one errors
 
     Code
-      join_rows(1, c(1, 1), relationship = "many_to_one")
+      join_rows(1, c(1, 1), relationship = "many-to-one")
     Condition
       Error:
       ! Each row in `x` must match at most 1 row in `y`.
@@ -68,13 +68,13 @@
 # join_rows() gives meaningful many-to-many warnings
 
     Code
-      join_rows(c(1, 1), c(1, 1), relationship = "warn_many_to_many")
+      join_rows(c(1, 1), c(1, 1), relationship = "warn-many-to-many")
     Condition
       Warning:
       Detected an unexpected many-to-many relationship between `x` and `y`.
       i Row 1 of `x` matches multiple rows in `y`.
       i Row 1 of `y` matches multiple rows in `x`.
-      i If a many-to-many relationship is expected, set `relationship = "many_to_many"` to silence this warning.
+      i If a many-to-many relationship is expected, set `relationship = "many-to-many"` to silence this warning.
     Output
       $x
       [1] 1 1 2 2
@@ -92,7 +92,7 @@
       Detected an unexpected many-to-many relationship between `x` and `y`.
       i Row 1 of `x` matches multiple rows in `y`.
       i Row 1 of `y` matches multiple rows in `x`.
-      i If a many-to-many relationship is expected, set `relationship = "many_to_many"` to silence this warning.
+      i If a many-to-many relationship is expected, set `relationship = "many-to-many"` to silence this warning.
     Output
         x
       1 1
@@ -351,7 +351,7 @@
     Condition
       Warning:
       Specifying `multiple = "error"` was deprecated in dplyr 1.1.1.
-      i Please use `relationship = "many_to_one"` instead.
+      i Please use `relationship = "many-to-one"` instead.
       Error:
       ! Each row in `x` must match at most 1 row in `y`.
       i Row 2 of `x` matches multiple rows in `y`.
@@ -363,7 +363,7 @@
     Condition
       Warning:
       Specifying `multiple = "error"` was deprecated in dplyr 1.1.1.
-      i Please use `relationship = "many_to_one"` instead.
+      i Please use `relationship = "many-to-one"` instead.
       Error in `left_join()`:
       ! Each row in `x` must match at most 1 row in `y`.
       i Row 2 of `x` matches multiple rows in `y`.
@@ -375,7 +375,7 @@
     Condition
       Warning:
       Specifying `multiple = "warning"` was deprecated in dplyr 1.1.1.
-      i Please use `relationship = "many_to_one"` instead.
+      i Please use `relationship = "many-to-one"` instead.
       Warning:
       Each row in `x` is expected to match at most 1 row in `y`.
       i Row 2 of `x` matches multiple rows.
@@ -387,7 +387,7 @@
     Condition
       Warning:
       Specifying `multiple = "warning"` was deprecated in dplyr 1.1.1.
-      i Please use `relationship = "many_to_one"` instead.
+      i Please use `relationship = "many-to-one"` instead.
       Warning in `left_join()`:
       Each row in `x` is expected to match at most 1 row in `y`.
       i Row 2 of `x` matches multiple rows.

tests/testthat/_snaps/join.md

@@ -59,7 +59,7 @@
       Detected an unexpected many-to-many relationship between `x` and `y`.
       i Row 1 of `x` matches multiple rows in `y`.
       i Row 1 of `y` matches multiple rows in `x`.
-      i If a many-to-many relationship is expected, set `relationship = "many_to_many"` to silence this warning.
+      i If a many-to-many relationship is expected, set `relationship = "many-to-many"` to silence this warning.
 
 # mutating joins compute common columns
 
@@ -202,7 +202,7 @@
 # `by = character()` technically respects `relationship`
 
     Code
-      left_join(df, df, by = character(), relationship = "many_to_one")
+      left_join(df, df, by = character(), relationship = "many-to-one")
     Condition
       Error in `left_join()`:
       ! Each row in `x` must match at most 1 row in `y`.

tests/testthat/test-group-by.R

@@ -55,8 +55,8 @@ test_that("joins preserve grouping", {
   df <- data.frame(x = rep(1:2, each = 4), y = rep(1:4, each = 2))
   g <- group_by(df, x)
 
-  expect_equal(group_vars(inner_join(g, g, by = c("x", "y"), relationship = "many_to_many")), "x")
-  expect_equal(group_vars(left_join(g, g, by = c("x", "y"), relationship = "many_to_many")), "x")
+  expect_equal(group_vars(inner_join(g, g, by = c("x", "y"), relationship = "many-to-many")), "x")
+  expect_equal(group_vars(left_join(g, g, by = c("x", "y"), relationship = "many-to-many")), "x")
   expect_equal(group_vars(semi_join(g, g, by = c("x", "y"))), "x")
   expect_equal(group_vars(anti_join(g, g, by = c("x", "y"))), "x")
 })

tests/testthat/test-join-rows.R

@@ -1,5 +1,5 @@
 test_that("`relationship` default behavior is correct", {
-  # "warn_many_to_many" for equality joins
+  # "warn-many-to-many" for equality joins
   expect_snapshot(out <- join_rows(c(1, 1), c(1, 1), condition = "=="))
   expect_equal(out$x, c(1L, 1L, 2L, 2L))
   expect_equal(out$y, c(1L, 2L, 1L, 2L))
@@ -170,28 +170,28 @@ test_that("join_rows() expects incompatible type errors to have been handled by
 
 test_that("join_rows() gives meaningful one-to-one errors", {
   expect_snapshot(error = TRUE, {
-    join_rows(1, c(1, 1), relationship = "one_to_one")
+    join_rows(1, c(1, 1), relationship = "one-to-one")
   })
   expect_snapshot(error = TRUE, {
-    join_rows(c(1, 1), 1, relationship = "one_to_one")
+    join_rows(c(1, 1), 1, relationship = "one-to-one")
   })
 })
 
 test_that("join_rows() gives meaningful one-to-many errors", {
   expect_snapshot(error = TRUE, {
-    join_rows(c(1, 1), 1, relationship = "one_to_many")
+    join_rows(c(1, 1), 1, relationship = "one-to-many")
   })
 })
 
 test_that("join_rows() gives meaningful many-to-one errors", {
   expect_snapshot(error = TRUE, {
-    join_rows(1, c(1, 1), relationship = "many_to_one")
+    join_rows(1, c(1, 1), relationship = "many-to-one")
   })
 })
 
 test_that("join_rows() gives meaningful many-to-many warnings", {
   expect_snapshot({
-    join_rows(c(1, 1), c(1, 1), relationship = "warn_many_to_many")
+    join_rows(c(1, 1), c(1, 1), relationship = "warn-many-to-many")
   })
 
   # With proof that the defaults flow through user facing functions