warning {loggit2}R Documentation

Warning Messages Log Handler

Description

This function is identical to base R's warning, but it includes logging of the exception message via loggit().

Usage

warning(
  ...,
  call. = TRUE,
  immediate. = FALSE,
  noBreaks. = FALSE,
  domain = NULL,
  .loggit = TRUE,
  echo = TRUE
)

Arguments

...

zero or more objects which can be coerced to character (and which are pasted together with no separator) or a single condition object.

call.

logical, indicating if the call should become part of the warning message.

immediate.

logical, indicating if the call should be output immediately, even if getOption("warn") <= 0.

noBreaks.

logical, indicating as far as possible the message should be output as a single line when options(warn = 1).

domain

see gettext. If NA, messages will not be translated, see also the note in stop.

.loggit

Should loggit() execute? Defaults to TRUE.

echo

Should loggit()'s log entry be echoed to the console, as well? Defaults to TRUE.

Value

The warning message as character string, invisibly.

See Also

Other handlers: message(), stopifnot(), stop()

Examples

  if (2 < 1) warning("You may want to review that math, and so this is your warning")


[Package loggit2 version 2.2.2 Index]