throw_error: Throw error *[Experimental]*

In rappster/clix: A custom CLI implementation

Throw error

Description

Throw error

Usage

throw_error(
  msg = "Error code: 1234",
  .console = FALSE,
  .log = FALSE,
  .envir = parent.frame()
)

Arguments

msg	(character) Error message. See stringr::str_glue().
.console	(logical) Output to console
.log	(logical) Output to log (console or file depending on logging settings) TODO-20220201-1627: flesh out logging details
.envir	(environment) Environment in which to evaluate msg expression

Examples

## Not run: 
throw_error(msg = "This is an error")

error_code <- 1234
throw_error(msg = "This is an error (error code: {error_code})", )

throw_error(msg = "This is an error", .console = TRUE)
throw_error(msg = "This is an error", .log = TRUE)

## End(Not run)

rappster/clix documentation built on Aug. 16, 2022, 9:54 p.m.