Add structure and choice assertions

Author: torfason

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: zmisc
 Title: Vector Look-Ups and Safer Sampling
-Version: 0.2.3.9005
+Version: 0.2.3.9006
 Author: Magnus Thor Torfason
 Maintainer: Magnus Thor Torfason <[email protected]>
 Description: A collection of utility functions that facilitate looking up

NAMESPACE

@@ -7,7 +7,10 @@ S3method(notate,haven_labelled)
 S3method(notate,ordered)
 export("ll_val_labels<-")
 export("ll_var_label<-")
+export(assert_atomic)
 export(assert_character)
+export(assert_choice)
+export(assert_class)
 export(assert_complex)
 export(assert_count)
 export(assert_data_frame)
@@ -29,6 +32,7 @@ export(assert_naturalish)
 export(assert_number)
 export(assert_numeric)
 export(assert_raw)
+export(assert_scalar)
 export(assert_string)
 export(assert_tibble)
 export(ddply_helper)

R/assertions.R

@@ -299,9 +299,23 @@ assert_date <- function(x, ...) {
   invisible(x)
 }
 
+# --- Type, class, and structure assertions ----
 
-#### Lists and tibbles
+#' @rdname checkmate_rlang
+#' @export
+assert_scalar <- function(x, ...) {
+  if (!isTRUE(check_scalar(x, ...)))
+    rlang::abort(check_scalar(x, ...))
+  invisible(x)
+}
 
+#' @rdname checkmate_rlang
+#' @export
+assert_atomic <- function(x, ...) {
+  if (!isTRUE(check_atomic(x, ...)))
+    rlang::abort(check_atomic(x, ...))
+  invisible(x)
+}
 
 #' @rdname checkmate_rlang
 #' @export
@@ -311,6 +325,26 @@ assert_list <- function(x, ...) {
   invisible(x)
 }
 
+#' @rdname checkmate_rlang
+#' @export
+assert_list <- function(x, ...) {
+  if (!isTRUE(check_list(x, ...)))
+    rlang::abort(check_list(x, ...))
+  invisible(x)
+}
+
+
+#' @rdname checkmate_rlang
+#' @export
+assert_class <- function(x, ...) {
+  if (!isTRUE(check_class(x, ...)))
+    rlang::abort(check_class(x, ...))
+  invisible(x)
+}
+
+
+# --- Tibble and data.frame assertions ----
+
 #' @rdname checkmate_rlang
 #' @export
 assert_data_frame <- function(x, ...) {
@@ -334,3 +368,16 @@ assert_tibble <- function(x, ...) {
     rlang::abort(check_tibble(x, ...))
   invisible(x)
 }
+
+
+# --- Set and value assertions ----
+
+
+#' @rdname checkmate_rlang
+#' @export
+assert_choice <- function(x, choices, ...) {
+  if (!isTRUE(check_choice(x, choices, ...)))
+    rlang::abort(check_choice(x, choices, ...))
+  invisible(x)
+}
+

man/checkmate_rlang.Rd

@@ -1,8 +1,11 @@
 
 test_that("There are no spelling errors", {
-  extract2 <- .Primitive("[[")
+  skip_on_cran()
   if (!file.exists(here::here("DESCRIPTION")))
     skip("Skipping, this only runs through testthat tests.")
+
+  # The actual test if we are not skipping it
+  extract2 <- .Primitive("[[")
   spelling::spell_check_package(here::here()) |>
     extract2("word") |>
     expect_equal(character())