mp_log: multiprobit log message methods

mp_log_resetR Documentation

multiprobit log message methods

Description

FUNCTION_DESCRIPTION

Usage

mp_log_reset()

mp_log_get()

mp_log_message(
  ...,
  domain = NULL,
  appendLF = TRUE,
  verbosity = 1,
  allow_verbose = TRUE,
  verbose = NULL,
  verbose_store = NULL
)

Arguments

...

Zero or more objects passed on to base::.makeMessage()

domain

Domain for translations, passed on to base::.makeMessage()

appendLF

logical; whether to add a newline to the message. Only used for verbose output.

verbosity

numeric value descibing the verbosity level of the message

allow_verbose

Whether to allow verbose output. Must be set to FALSE until the options object has been initialised.

verbose

logical, numeric, or NULL; local override for verbose output. If NULL, the global option or default value is used. If FALSE, no messages are printed. If TRUE, messages with verbosity \leq 1 are printed. If numeric, messages with verbosity \leq verbose are printed.

verbose_store

Same as verbose, but controlling what messages are stored in the global log object.

Details

mp_log_reset() clears the log contents.

mp_log_message DETAILS

Value

mp_log_get RETURN_VALUE

mp_log_message OUTPUT_DESCRIPTION

Examples

## Not run: 
if (interactive()) {
  # EXAMPLE1
}

## End(Not run)
## Not run: 
if (interactive()) {
  # EXAMPLE1
}

## End(Not run)

finnlindgren/multiprobit documentation built on June 14, 2025, 1:12 p.m.