Patch options

.gitignore

@@ -53,3 +53,4 @@ rsconnect/
 
 # dev site
 dev/
+inst/doc

DESCRIPTION

@@ -1,30 +1,35 @@
 Package: zephyr
 Title: Tools for Informing Users Based on Package Options
-Version: 0.0.5
+Version: 0.0.4.9000
 Authors@R: c(
     person("Aksel", "Thomsen", , "[email protected]", role = c("aut", "cre")),
     person("Mathias Lerbech", "Jeppesen", , "[email protected]", role = "aut"),
     person("Cervan", "Girard", , "[email protected]", role = "aut"),
-    person("Kristian", "Troejelsgaard", ,"[email protected]", role = "aut"),
+    person("Kristian", "Troejelsgaard", , "[email protected]", role = "aut"),
     person("Lovemore", "Gakava", , "[email protected]", role = "aut"),
     person("Steffen Falgreen", "Larsen", , "[email protected]", role = "aut"),
-    person("Vladimir", "Obucina", , "[email protected]", role = c("aut")),
-    person("Novo Nordisk A/S", role = c("cph"))
+    person("Vladimir", "Obucina", , "[email protected]", role = "aut"),
+    person("Novo Nordisk A/S", role = "cph")
   )
-Description: Tools for helping developers of R packages inform their users.
-    Package enables writing messages based on package level options.
+Description: Tools for helping developers of R packages inform their
+    users. Package enables writing messages based on package level
+    options.
 License: Apache License (>= 2)
-Encoding: UTF-8
-Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.2
+URL: https://novonordisk-opensource.github.io/zephyr/,
+    https://github.com/NovoNordisk-OpenSource/zephyr
+Imports: 
+    cli,
+    rlang
 Suggests: 
-    testthat (>= 3.0.0),
-    withr,
     checkmate,
-    dplyr
+    dplyr,
+    glue,
+    knitr,
+    rmarkdown,
+    testthat (>= 3.0.0),
+    usethis,
+    withr
 Config/testthat/edition: 3
-URL: https://novonordisk-opensource.github.io/zephyr/, https://github.com/NovoNordisk-OpenSource/zephyr
-Imports: 
-    cli,
-    rlang,
-    utils
+Encoding: UTF-8
+Roxygen: list(markdown = TRUE)
+RoxygenNote: 7.3.2

NAMESPACE

@@ -7,20 +7,18 @@ export(envvar_is_true_pkg)
 export(envvar_str_split_pkg)
 export(get_all_verbosity_levels)
 export(get_option_spec_pkg)
-export(get_package_name_and_env_verbosity)
-export(get_package_name_and_verbosity)
-export(get_package_option)
 export(get_verbosity_level)
 export(msg)
+export(msg_danger)
 export(msg_debug)
-export(msg_minimal)
+export(msg_info)
 export(msg_success)
+export(msg_verbose)
+export(msg_warning)
 export(opt_pkg)
 export(opt_source_pkg)
 export(option_spec_pkg)
 export(opts_pkg)
 export(remove_option_pkg)
 export(report_checkmate_assertions)
-importFrom(rlang,call_name)
-importFrom(rlang,call_ns)
-importFrom(utils,getFromNamespace)
+export(use_zephyr)

R/checkmate.R

@@ -1,14 +1,15 @@
 #' Report collection of assertions
 #' @description
-#' Improved reporting of `AssertCollections` created with the [checkmate::makeAssertCollection()] package
+#' Improved reporting of `AssertCollections` created with the [checkmate::makeAssertCollection()]
 #' using [cli::cli_abort()] instead of [checkmate::reportAssertions()] in order to provide a more
 #' informative error message.
 #'
 #' The function is intended to be used inside a function that performs assertions on its input arguments.
 #' See below for an example.
-#' @param collection A collection of assertions created with [checkmate::makeAssertCollection()]
-#' @param msg [character()] Header of the error message if any assertions failed
-#' @param env [environment()] Environment to use for the error message
+#' @param collection A collection of assertions created with [checkmate::makeAssertCollection()].
+#' @param message `character` string with the header of the error message if any assertions failed
+#' @param .envir The `environment` to use for the error message.
+#' Default `parent.frame()` will be sufficient for most use cases.
 #' @examples
 #' add_numbers <- function(a, b) {
 #'   collection <- checkmate::makeAssertCollection()
@@ -24,12 +25,14 @@
 #'
 #' @export
 
-report_checkmate_assertions <- function(collection, msg = "Invalid input(s):", env = parent.frame()) {
+report_checkmate_assertions <- function(collection, message = "Invalid input(s):", .envir = parent.frame()) {
+  rlang::check_installed("checkmate")
+
   checkmate::assert_class(collection, "AssertCollection")
 
   if (!collection$isEmpty()) {
-    c(msg, rlang::set_names(collection$getMessages(), "x")) |>
-      cli::cli_abort(.envir = env)
+    c(message, rlang::set_names(collection$getMessages(), "x")) |>
+      cli::cli_abort(.envir = .envir)
   }
   invisible(TRUE)
 }