log_start: Start a Logging Session

View source: R/log.R

log_startR Documentation

Start a Logging Session

Description

log_start() begins diverting message stream (stderr) output to the specified log file. Only one logging session can be active at a time.

Usage

log_start(file, dir = log_dir(), append = TRUE, force = FALSE)

Arguments

file

The log file name. If path components are included they are assumed to be relative to dir.

dir

The log directory. log_dir(), the default, returns the current log directory, or NULL if none is set. The latter case will cause file to be created in or relative to your current working directory.

append

Should an existing file be appended to?

force

If append = FALSE, should an existing file be overwritten?

Value

The path to the log file (invisibly)


jesse-smith/coviData documentation built on Jan. 14, 2023, 11:08 a.m.