Log an error leaf line — log

Also elevates the currently-open step's status to "error", so the step's close line renders the elevated glyph even though the enclosing function returns normally (see with_logging() for the case where the step's code actually throws instead).

Usage

log_error(msg, close = FALSE, summary = NA)

Arguments

msg: Character scalar.
close: Logical. When TRUE, force-close the enclosing section after this line: the line is shown as the section's terminal (corner) line and its Done line is suppressed. Defaults to FALSE.
summary: Whether to record this line in the logtree_summary() digest. NA (default) records it only when it is a warning or error; TRUE always records it; FALSE never does.

Value

NULL, invisibly.

Examples

logtree_reset()
log_error("model timeout after 30s")
#> ✖ model timeout after 30s