openlog: Open a new logfile

In bpbond/luzlogr: Lightweight Logging for R Scripts

Open a new logfile

Description

Open a new logfile

Usage

openlog(file, loglevel = -Inf, append = FALSE, sink = FALSE)

Arguments

file	Name of logfile (character or writeable connection)
loglevel	Minimum priority level (numeric, optional)
append	Append to logfile? (logical, optional)
sink	Send all console output to logfile? (logical, optional)

Details

Open a new logfile. Messages will only appear in the logfile if their level exceeds the log's loglevel; this allows you to easily change the amount of detail being logged.

Re-opening a logfile will erase the previous output unless append is TRUE. Opening a new logfile when one is already open will temporarily switch logging to that new file.

If sink is TRUE, all screen output will be captured (via sink).

Value

Invisible fully-qualified name of log file.

See Also

printlog closelog

Examples

logfile <- openlog("test.log")
printlog("message")
closelog()
readLines(logfile)
file.remove(logfile)

bpbond/luzlogr documentation built on March 2, 2024, 11:14 p.m.