log_info {logr} | R Documentation |
Logs an informational message
Description
Writes an informational message to the log. Message will be written to the log at the point the function is called.
Usage
log_info(msg, console = TRUE, blank_after = NULL, hide_notes = FALSE)
Arguments
msg |
The message to log. The message must be a character string. |
console |
Whether or not to print to the console. Valid values are TRUE and FALSE. Default is TRUE. |
blank_after |
Whether or not to print a blank line following the printed message. The blank line helps readability of the log. Valid values are TRUE and FALSE. Default is TRUE. |
hide_notes |
If notes are on, this parameter gives you the option of not printing notes for a particular log entry. Default is FALSE, meaning notes will be displayed. Used internally. |
Value
The object, invisibly
See Also
log_warning
to write a warning message to the log.
Examples
library(logr)
# Create temp file location
tmp <- file.path(tempdir(), "test.log")
# Open log
lf <- log_open(tmp)
# Send info to log
log_info("Here is an info message")
# Close log
log_close()
# View results
writeLines(readLines(lf))
[Package logr version 1.3.9 Index]