Soft deprecate assert_dimensions()

tesselle · Nov 7, 2024 · b043fba · b043fba
1 parent fac98ec
commit b043fba
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/R/arkhe-deprecated.R b/R/arkhe-deprecated.R
@@ -1,4 +1,4 @@
-# DATA CLEANING: APPEND
+# DEPRECATED
 #' @include assert.R
 NULL
 
@@ -11,4 +11,7 @@ NULL
 
 #' @export
 #' @rdname arkhe-deprecated
-assert_dimensions <- assert_dim
+assert_dimensions <- function(x, expected) {
+  # .Deprecated("assert_dim()", old = "assert_dimensions()")
+  assert_dim(x, expected)
+}
diff --git a/inst/tinytest/test_assert.R b/inst/tinytest/test_assert.R
@@ -68,7 +68,7 @@ expect_identical(assert_empty(k), k)
 
 ## Dimensions ------------------------------------------------------------------
 k <- matrix(1, nrow = 10, ncol = 5)
-cnd <- arkhe:::catch_conditions(assert_dimensions(k, expected = c(5, 10)))
+cnd <- arkhe:::catch_conditions(assert_dim(k, expected = c(5, 10)))
 expect_inherits(cnd[[1]], "error_bad_dimensions")
 
 cnd <- arkhe:::catch_conditions(assert_nrow(k, expected = 5))
@@ -77,7 +77,7 @@ expect_inherits(cnd[[1]], "error_bad_dimensions")
 cnd <- arkhe:::catch_conditions(assert_ncol(k, expected = 10))
 expect_inherits(cnd[[1]], "error_bad_dimensions")
 
-expect_identical(assert_dimensions(k, expected = c(10, 5)), k)
+expect_identical(assert_dim(k, expected = c(10, 5)), k)
 
 ## Names -----------------------------------------------------------------------
 k <- vector(mode = "numeric", length = 10)