Writes an informational message to the log. Message will be written to the log at the point the function is called.
log_info(msg, console = TRUE, blank_after = NULL, hide_notes = FALSE)The message to log. The message must be a character string.
Whether or not to print to the console. Valid values are TRUE and FALSE. Default is TRUE.
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.
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.
The object, invisibly
log_warning to write a warning message to the log.
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")
#> Info: Here is an info message
# Close log
log_close()
# View results
writeLines(readLines(lf))
#> =========================================================================
#> Log Path: /tmp/RtmpORwY5l/log/test.log
#> Working Directory: /cluster-data/user-homes/elizabethb/projects/prism-pkgdocs-build/installed-pkgs/priority-3/logr_1.3.9/docs/reference
#> User Name: elizabethb
#> R Version: 4.4.1 (2024-06-14)
#> Machine: uat-uat-a2ai-cloud x86_64
#> Operating System: Linux 6.2.0-1018-aws #18~22.04.1-Ubuntu SMP Wed Jan 10 22:54:16 UTC 2024
#> Base Packages: stats graphics grDevices utils datasets methods base
#> Other Packages: logr_1.3.9 common_1.1.3
#> Log Start Time: 2025-10-14 20:31:04.862883
#> =========================================================================
#>
#> Info: Here is an info message
#>
#> NOTE: Log Print Time: 2025-10-14 20:31:04.864985
#> NOTE: Elapsed Time: 0.00152492523193359 secs
#>
#> =========================================================================
#> Log End Time: 2025-10-14 20:31:04.866227
#> Log Elapsed Time: 0 00:00:00
#> =========================================================================