feat: new simple internal options and verbosity level

[akselthomsen]

Large update of zephyr

• Aim is to be the basis of our first CRAN release.
• Due to internal requirements of supporting older R versions it implements basic functionality to work with package specific options similar to the ones previously used from {options} package. In documentation it has been noted that our implementation is just targeted our needs, and we recommend {options} for general usage.
• Verbosity level is updated to be created as a package option, and the get_verbosity_level() functions are now based on get_option().
• A utility function use_zephyr() has been added to easily setup the above in your package.
• Documentation has been updated with new functions.
• Updated tests as well, so we now have 100% test coverage, and a simplistic integration test where zephyr is used in a new package. The Suggest imports of callr and devtools are due to this test. There may be a way to achieve the same with less imports.

[Lovemore-Gakava]

I propose modifying the msg function to utilize cli::cli_alert instead of its current use of cli::cli_alert_info. This change would allow us to create a distinction between the general msg function and a more specific msg_info function. As an example:

> foo <- function() {
+   msg_debug("Some important debug information about the function")
+   msg("Starting calculations")
+  
+   result <- 1 + 1 # Replace with long calculations and how to create output
+   
+   msg("getting output creation status")
+   
+   if (result == 2) {
+     msg_success("Output created")
+   } else {
+     msg_danger("Output not created correctly")
+   }
+   
+   return(result)
+ }
> 
> withr::with_options(
+   new = list(zephyr.verbosity_level = "debug"),
+   code = foo()
+ )
ℹ Some important debug information about the function
→ Starting calculations
→ getting output creation status
✔ Output created
[1] 2

[github-actions]

Code coverage

Name	Coverage (%)
zephyr	98.48
R/checkmate.R	100.00
R/msg.R	100.00
R/options.R	100.00
R/use_zephyr.R	100.00
R/utils.R	100.00
R/verbosity_level.R	100.00
R/zzz.R	0.00

[github-actions]

Github pages

Review the pkgdown webpage for the PR here