logger.status {RnBeads}R Documentation

Writing text messages to the log file.

Description

Appends a single-line status message to the log text file. The message is prepended by its type, which is one of STATUS, INFO, WARNING or ERROR.

Usage

logger.status(txt)

logger.info(txt)

logger.warning(txt)

logger.error(txt, terminate = rnb.getOption("logging.exit.on.error"))

Arguments

txt

Text to add to the log file. This must be a character vector; its elements are concatenated using a single space (" ") as a separator.

terminate

Flag indicating if the execution is to be terminated after this error message is added to the log.

Value

None (invisible NULL).

Author(s)

Yassen Assenov

See Also

logger.isinitializedto check if logging is activated; logger.start for initializing a logger or starting a section

Examples


if (!logger.isinitialized())
  logger.start(fname = NA)
logger.status(c("Reached step", 2))
logger.info(c("Provided email:", rnb.getOption("email")))
[Package RnBeads version 2.5.0 Index]