| Type: | Package |
| Title: | Lightweight Logging for R Scripts |
| Version: | 0.2.1 |
| Description: | Provides flexible but lightweight logging facilities for R scripts. Supports priority levels for logs and messages, flagging messages, capturing script output, switching logs, and logging to files or connections. |
| Imports: | assertthat (≥ 0.2) |
| Depends: | R (≥ 3.0) |
| License: | MIT + file LICENSE |
| Encoding: | UTF-8 |
| Suggests: | testthat, knitr, rmarkdown |
| VignetteBuilder: | knitr |
| RoxygenNote: | 7.3.1 |
| NeedsCompilation: | no |
| Packaged: | 2024-02-27 01:29:31 UTC; bpbond |
| Author: | Ben Bond-Lamberty 
[cre, aut] |
| Maintainer: | Ben Bond-Lamberty <bondlamberty@pnnl.gov> |
| Repository: | CRAN |
| Date/Publication: | 2024-02-27 06:00:02 UTC |
Close current logfile
Description
Close current logfile
Usage
closelog(sessionInfo = TRUE)
Arguments
sessionInfo |
Append |
Details
Close current logfile. The number of flagged messages is returned,
invisibly. Note that if options(luzlogr.close_on_error = TRUE) is set, then
if an error occurs, all log files will be automatically closed. This behavior
is not currently enabled by default.
Logs are stored on a stack, and so when one is closed, logging output returns to the previous log (if any).
Value
Number of flagged messages (numeric).
Note
If the log was being written to a connection,
closelog will return the connection to its pre-logging state,
whether open or closed.
See Also
Examples
logfile1 <- openlog("A.log")
printlog("message to A", flag = TRUE)
logfile2 <- openlog("B.log")
printlog("message to B")
flagcountB <- closelog()
flagcountA <- closelog(sessionInfo = FALSE)
file.remove(logfile1, logfile2)
Get current log info
Description
Get current log info
Usage
getloginfo()
Details
This handles internal data tracking only, not the file on disk.
Value
A list with information about current (active) log.
Create new log
Description
Create new log
Usage
newlog(logfile, loglevel, sink, description, closeit)
Arguments
logfile |
Name of log file (character or connection) |
loglevel |
Minimum priority level (numeric) |
sink |
Send all console output to logfile? (logical) |
description |
Description (character) |
closeit |
File should be closed when log closes? (logical) |
Details
This handles internal data tracking only, not the file on disk.
Return number of current logs
Description
Return number of current logs
Usage
nlogs()
Value
Number of current logs (numeric).
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 |
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
Examples
logfile <- openlog("test.log")
printlog("message")
closelog()
readLines(logfile)
file.remove(logfile)
Log a message
Description
Log a message
Usage
printlog(..., level = 0, ts = TRUE, cr = TRUE, flag = FALSE, flush = FALSE)
flaglog(...)
Arguments
... |
Expressions to be printed to the log |
level |
Priority level (numeric, optional) |
ts |
Print preceding timestamp? (logical, optional) |
cr |
Print trailing newline? (logical, optional) |
flag |
Flag this message (e.g. error or warning) (logical, optional) |
flush |
Immediately flush output to file (logical, optional) |
Details
Logs a message, which consists of zero or more printable objects. Simple objects (numeric and character) are printed together on a single line, whereas complex objects (data frames, etc) start on a new line by themselves.
If the current log was opened with sink = TRUE,
messages are printed to the screen, otherwise not. Messages can be flagged;
flaglog assumes
that the message is to be flagged, whereas printlog does not.
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.
Value
Invisible success (TRUE) or failure (FALSE).
Note
A message's preceding timestamp and following carriage return can be
suppressed using the ts and cr parameters.
See Also
Examples
logfile <- openlog("test.log")
printlog("message")
printlog(1, "plus", 1, "equals", 1 + 1)
closelog()
readLines(logfile)
file.remove(logfile)
logfile <- openlog("test", loglevel = 1)
printlog("This message will not appear", level = 0)
printlog("This message will appear", level = 1)
closelog()
readLines(logfile)
file.remove(logfile)
Remove current log
Description
Remove current log
Usage
removelog()
Details
This handles internal data tracking only, not the file on disk.
Value
The just-removed log info.
Set log data
Description
Set log data
Usage
setlogdata(datum, value)
Arguments
datum |
Name of datum to set (character) |
value |
Value |
Details
This handles internal data tracking only, not the file on disk.