set_logfile {loggit2}R Documentation

Set Log File

Description

Set the log file that loggit will write to by default.

Usage

set_logfile(logfile = NULL, confirm = TRUE, create = TRUE)

Arguments

logfile

Absolut or relative path to log file. An attempt is made to convert the path into a canonical absolute form using normalizePath(). If NULL will set to ⁠<tmpdir>/loggit.log⁠.

confirm

Print confirmation of log file setting?

create

Create the log file if it does not exist?

Details

No logs outside of a temporary directory will be written until this is set explicitly, as per CRAN policy. Therefore, the default behavior is to create a file named loggit.log in your system's temporary directory.

Value

Invisible the previous log file path.

Examples

## Not run: 
  set_logfile("path/to/logfile.log")

## End(Not run)

[Package loggit2 version 2.3.1 Index]