set_options_warn_error: Setting global 'warn' and 'error' options

In Burke-Lauenroth-Lab/rSFSW2: Simulation Framework for SOILWAT2

Description

Setting global 'warn' and 'error' options

Usage

set_options_warn_error(
  debug.warn.level = 1L,
  debug.dump.objects = FALSE,
  dir_prj = ".",
  verbose = FALSE
)

Arguments

debug.warn.level	An integer value. Sets the warn option.
debug.dump.objects	A logical value. Sets the error option. See details section.
dir_prj	A character string. The path at which the RData file are saved if debug.dump.objects is turned on.
verbose	A logical value.

Value

A list of length two with elements 'warn' and 'error' containing the status of these two global options before resetting them by this function.

Details

Accepted values of debug.warn.level are

• warn < 0: warnings are ignored

• warn = 0: warnings are stored until the top-level function returns

• warn = 1: warnings are printed as they occur

• warn = 2: all warnings are turned into errors.

If debug.dump.objects is TRUE, then code will on error dump objects and frames to files at path dir_prj, and (if not in interactive mode) quit. To view the dumped frames first attach them with load(file.path(dir_prj, "last.dump.rda")) and then browse them with debugger(`path/to/file/last.dump.rda`)

Burke-Lauenroth-Lab/rSFSW2 documentation built on Aug. 14, 2020, 5:20 p.m.