flog_start: Start logging

In lorenzwalthert/drogger:

Start logging

Description

Note that chaning the absolute path under which the logger is initialized and then issuing a logging statement will result in an error because the absolute path for logging is used so logging statements can be created from arbitrary working directories (i.e. within [withr::with_dir()]).

Usage

flog_start(threshold = futile.logger::INFO,
  name = background_file_logger(), msg = "Started logging run",
  root = ".")

Arguments

threshold	The new threshold for the given logger.
name	The name of the logger.
msg	An initial message to pass to the logger.
root	The root logging directory. Sometimes, it might be convenient to log to a temporary directory and then copy the log later somewhere else.

Value

Invisibly returns the path to the file that contains the log.

lorenzwalthert/drogger documentation built on April 4, 2024, 9:32 a.m.