formatter_logging: Mimic the default formatter used in the 'logging' package

formatter_loggingR Documentation

Mimic the default formatter used in the logging package

Description

The logging package uses a formatter that behaves differently when the input is a string or other R object. If the first argument is a string, then sprintf is being called – otherwise it does something like log_eval and logs the R expression(s) and the result(s) as well.

Usage

formatter_logging(
  ...,
  .logcall = sys.call(),
  .topcall = sys.call(-1),
  .topenv = parent.frame()
)

Arguments

...

string and further params passed to sprintf or R expressions to be evaluated

.logcall

the logging call being evaluated (useful in formatters and layouts when you want to have access to the raw, unevaluated R expression)

.topcall

R expression from which the logging function was called (useful in formatters and layouts to extract the calling function's name or arguments)

.topenv

original frame of the .topcall calling function where the formatter function will be evaluated and that is used to look up the namespace as well via logger:::top_env_name

Value

character vector

See Also

This is a log_formatter, for alternatives, see formatter_paste, formatter_glue, formatter_glue_safe, formatter_glue_or_sprintf, formatter_json, formatter_pander and skip_formatter for marking a string not to apply the formatter on it.

Examples

## Not run: 
log_formatter(formatter_logging)
log_info('42')
log_info(42)
log_info(4+2)
log_info('foo %s', 'bar')
log_info('vector %s', 1:3)
log_info(12, 1+1, 2 * 2)

## End(Not run)

daroczig/logger documentation built on March 8, 2024, 6:49 p.m.