logMessage: Write a message to the current log file.

Description Usage Arguments Details Value Examples

View source: R/logTools.R

Description

logMessage uses cat() to append a message to the current log file. The file name is taken from the rete.logfile global option.

Usage

1

Arguments

msg

a character object or vector of character objects.

Details

The function will stop() if message is not of mode, type and class character. On windows systems, cat() replaces \n linebreaks with \r\n. Therefore logMessage() converts all linebreaks internally to \n before handing them to cat().

Value

N/A. This function is invoked for its side-effect to appended text to the current logfile.

Examples

1
2
3
4
5
## Not run: 
  msg <- c("note > ", Sys.Date(), "Re-run analysis.")
  logMessage(msg)

## End(Not run)

hyginn/ekplektoR documentation built on May 17, 2017, 12:08 a.m.