MazamaWebUtils (version 0.1.7)

stopOnError: Error Message Translator

Description

When writing R code to be used in production systems that work with user supplied input, it is important to enclose chunks of code inside of a try() block. It is equally important to generate error log messages that can be found and understood during an autopsy when something fails

At Mazama Science we have our own internal standard for how to do error handling in a manner that allows os to quickly navigate to the source of errors in a production system.

The example section contains a snippet of how we use this function.

Usage

stopOnError(result, err_msg = "")

Arguments

result

return from a try() block

err_msg

custom error message

Value

Issues a stop() with an appropriate error message.

Examples

# NOT RUN {
logger.setup()

# Arbitrarily deep in the stack we might have:
myFunc <- function(x) {
  a <- log(x)
}

userInput <- 10
result <- try({
  myFunc(x=userInput)
}, silent=TRUE)
stopOnError(result)

userInput <- "ten"
result <- try({
  myFunc(x=userInput)
}, silent=TRUE)
stopOnError(result)

result <- try({
  myFunc(x=userInput)
}, silent=TRUE)
stopOnError(result, "Unable to process user input")
# }

Run the code above in your browser using DataCamp Workspace