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)

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")
#> Info: Here is an info message 

# Close log
log_close()

# View results
writeLines(readLines(lf))
#> =========================================================================
#> Log Path: C:/Users/dbosa/AppData/Local/Temp/RtmpsjFzDn/log/test.log
#> Working Directory: C:/packages/logr/docs/reference
#> User Name: dbosa
#> R Version: 4.6.1 (2026-06-24 ucrt)
#> Machine: SOCRATES x86-64
#> Operating System: Windows 10 x64 build 26200
#> Base Packages: stats graphics grDevices utils datasets methods base
#> Other Packages: logr_1.4.0 common_1.1.5
#> Log Start Time: 2026-10-15 21:26:36.701835
#> =========================================================================
#> 
#> Info: Here is an info message
#> 
#> NOTE: Log Print Time:  2026-10-15 21:26:36.705135
#> NOTE: Elapsed Time: 0.00165414810180664 secs
#> 
#> =========================================================================
#> Log End Time: 2026-10-15 21:26:36.707313
#> Log Elapsed Time: 0 00:00:00
#> =========================================================================