Pre-formatted message functions

Source: R/msgInfo.R

Convenient wrappers around message() to sent styled notices to the user while a function/script is being executed.

msgInfo(..., appendLF = TRUE)

msgError(..., appendLF = TRUE)

msgSuccess(..., appendLF = TRUE)

msgWarning(..., appendLF = TRUE)

Arguments

...

text to be passed to paste().
appendLF

a logical. Should messages given as a character string have a new line appended ?

Value

Reports an info.

Functions

  • msgError: Reports an Error.

  • msgSuccess: Reports a success.

  • msgWarning: Reports a warning.

Note

All of these functions call message(), so for any function FUN() using #' them, suppressMessages(FUN()) is sufficient to mute all messages.

See also

cli::symbol() message()

Examples

msgInfo("computing")

#> ℹ computing
msgSuccess("done")

#> ✔ done
msgError("you got it wrong")

#> ✖ you got it wrong
msgWarning("be careful")

#> ⚠ be careful