Enhancement/quiet-messaging

NAMESPACE

@@ -9,6 +9,8 @@ export(generate_params)
 export(hector_matrix)
 export(is.criterion)
 export(iterate_model)
+export(matilda_message)
+export(matilda_warning)
 export(metric_calc)
 export(metric_calc_1run)
 export(multi_criteria_weighting)

R/hush.R

@@ -0,0 +1,47 @@
+# Set an option to control whether messages and warning are suppressed.
+# Defaults to verbose messaging.
+options("matilda.verbose" = FALSE)
+
+# Quiet messages
+
+#' Suppressing messages in Matilda functions
+#'
+#' @param ... Message to print if verbosity option is set to TRUE.
+#'
+#' @export
+#'
+matilda_message <- function(...) {
+
+  # Get the current verbose option setting
+  message.option <- getOption("matilda.verbose")
+
+  # Check if the verbose option is set to FALSE
+  if (message.option == FALSE) {
+    # If FALSE, exit function without displaying message
+    return()
+  }
+  # If verbose option is TRUE, display message
+  message(...)
+}
+
+# Quiet warnings
+
+#' Suppressing warnings in Matilda functions
+#'
+#' @param ... Warning to print if verbosity option is set to TRUE.
+#'
+#' @export
+#'
+matilda_warning <- function(...) {
+
+  # Get the current verbose option setting
+  warning.option <- getOption("matilda.verbose")
+
+  # Check if the verbose option if set to FALSE
+  if (warning.option == FALSE) {
+    # If FALSE, exit the function without displaying message
+    return()
+  }
+  # If verbose option is TRUE, display message
+  warning(...)
+}

R/iterate_model.R

@@ -95,6 +95,7 @@ metric_calc_1run <- function(x, metric) {
 #' @export
 #'
 #' @examples
+#' options("matilda.verbose" = TRUE)
 #' # Load scenario file and initiate a new Hector core
 #' ssp245 <- system.file("input/hector_ssp245.ini", package = "hector")
 #' core <- newcore(ssp245)

R/set_params.R

@@ -20,7 +20,7 @@
 set_params <- function(core, param_values) {
   # If parameters values are not numeric - stop and send error
   if (length(param_values) == 0) {
-    warning("no parameters")
+    matilda_warning("no parameters")
     return()
   }
 
@@ -43,7 +43,7 @@ set_params <- function(core, param_values) {
     var_units <- getunits(var)
 
     # send a message for what each var is being set to
-    message("setting ", var, " to ", param_values[i])
+    matilda_message("setting ", var, " to ", param_values[i])
 
     # set variables to be passed to
     setvar(core, NA, var = var, values = param_values[i], unit = var_units)

tests/testthat/test-set_params.R

@@ -4,6 +4,9 @@ y <- c("BETA" = 1, "Q10_RH" = 2)
 # core
 core <- newcore(system.file("input/hector_ssp245.ini", package = "hector"))
 
+# set verbose option to TRUE
+options(matilda.verbose = TRUE)
+
 # Checking message printed - may not be necessary
 test_that("function returns message", {
   expect_message(set_params(

vignettes/matilda-vignette.Rmd

@@ -37,6 +37,10 @@ First, load the `matilda` package
 library(matilda)
 ```
 
+```{r, echo=FALSE}
+options("matilda.verbose" = FALSE)
+```
+
 Next, we will initialize a "core" for a new Hector instance. 
 More information about establishing a new core for running Hector can be found in the tutorial for using the [Hector R interface](https://jgcri.github.io/hector/articles/intro-to-hector.html).
 
@@ -80,7 +84,7 @@ The `iterate_model()` runs Hector multiple times, setting new parameter values w
 
 Running `iterate_model()` requires a Hector core and a data frame of parameter values.
 
-```{r, message=FALSE}
+```{r}
 # Run Hector repeatedly over all parameter values
 results <- iterate_model(
   core = c_ssp245,