omnipath_msg: Dispatch a message to the OmnipathR logger

View source: R/log.R

omnipath_msgR Documentation

Dispatch a message to the OmnipathR logger

Description

Any package or script can easily send log messages and establish a logging facility with the fantastic 'logger' package. This function serves the only purpose if you want to inject messages into the logger of OmnipathR. Otherwise we recommend to use the 'logger' package directly.

Usage

omnipath_msg(level, ...)

Arguments

level

Character, numeric or class loglevel. A log level, if character one of the followings: "fatal", "error", "warn", "success", "info", "trace".

...

Arguments for string formatting, passed sprintf or str_glue.

Value

Returns 'NULL'.

Examples

omnipath_msg(
    level = 'success',
    'Talking to you in the name of OmnipathR, my favourite number is %d',
    round(runif(1, 1, 10))
)


saezlab/OmnipathR documentation built on Oct. 16, 2024, 11:49 a.m.