lgr: standardize_threshold – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

standardize_threshold

Standardize User-Input Log Levels to Their Integer Representation

Description

These are helper functions for verifying log levels and converting them from their character to their integer representations. This is primarily useful if you want to build your own Loggers, Appenders or Layouts and need to handle log levels in a way that is consistent with lgr .

Usage

standardize_threshold(
  x,
  log_levels = c(getOption("lgr.log_levels"), c(all = NA_integer_, off = 0L))
)

is_threshold(x)

standardize_log_level(x, log_levels = getOption("lgr.log_levels"))

is_log_level(x)

standardize_log_levels(x, log_levels = getOption("lgr.log_levels"))

is_log_levels(x)

Arguments

`x`	a `character` or `integer` scalar, or vector for standardize_log_levels
`log_levels`	named `integer` vector of valid log levels

Value

An unnamed integer vector

Examples

standardize_threshold("info")
standardize_threshold("all")
is_threshold("all")
is_threshold("foobar")

standardize_log_level("info")
# all is a valid threshold, but not a valid log level
try(is.na(standardize_log_level("all")))
is_log_level("all")

# standardized_log_level intentionally only works with scalars, because many
# functions require scalar log level inputs
try(standardize_log_level(c("info", "fatal")))

# You can still use standardize_log_levels() (plural) to work with vectors
standardize_log_levels(c("info", "fatal"))

lgr

A Fully Featured Logging Framework

v0.4.2

MIT + file LICENSE

Authors

Stefan Fleck [aut, cre] (<https://orcid.org/0000-0003-3344-9851>)

Initial release