log_message: Print diagnostic message

In thisutils: Collection of Utility Functions for Data Analysis and Computing

Print diagnostic message

Description

Integrate the message printing function with the cli package, and the base::message function. The message could be suppressed by base::suppressMessages.

Usage

log_message(
  ...,
  verbose = TRUE,
  message_type = c("info", "success", "warning", "error"),
  cli_model = TRUE,
  timestamp = TRUE,
  timestamp_format = "%Y-%m-%d %H:%M:%S",
  level = 1,
  symbol = "  ",
  format = FALSE,
  text_color = NULL,
  back_color = NULL,
  multiline_indent = TRUE
)

Arguments

...	Text to print.
verbose	Logical value, default is TRUE. Whether to print the message.
message_type	Type of message, default is info. Could be choose one of info, success, warning, and error.
cli_model	Logical value, default is TRUE. Whether to use the cli package to print the message.
timestamp	Logical value, default is TRUE. Whether to show the current time in the message.
timestamp_format	Character value, default is "%Y-%m-%d %H:%M:%S". Format string for timestamp display.
level	Integer value, default is 1. The level of the message, which affects the indentation. Level 1 has no indentation, higher levels add more indentation.
symbol	Character value, default is " " (two spaces). The symbol used for indentation. When specified, it ignores the level parameter and uses the symbol directly.
format	Logical value, default is FALSE. Whether to use sprintf-style formatting for the message.
text_color	Character value, default is NULL. Color for the message text. Available colors: "red", "green", "blue", "yellow", "magenta", "cyan", "white", "black".
back_color	Character value, default is NULL. Background color for the message text. Available colors: "red", "green", "blue", "yellow", "magenta", "cyan", "white", "black".
multiline_indent	Logical value, default is TRUE. Whether to apply consistent formatting (timestamp and indentation) to each line in multiline messages. When TRUE, each line gets the full formatting; when FALSE, only the first line gets the timestamp.

Value

Formated message printed to the console.

References

https://cli.r-lib.org/articles/index.html

Examples

# basic usage
log_message("Hello, ", "world!")
log_message("hello, world!")
log_message("Hello, world!", timestamp = FALSE)
log_message("Hello, ", "world!", message_type = "success")
log_message("Hello, world!", message_type = "warning")
log_message("Hello, ", "world!", cli_model = FALSE)

# suppress messages
suppressMessages(log_message("Hello, world!"))
log_message("Hello, world!", verbose = FALSE)

# cli formatting
log_message("hello, {.arg world}!")
message("hello, {.arg world}!")
log_message("hello, {.code world}!")
message("hello, {.code world}!")
log_message("{.emph R}")
log_message("Hello, {.file world}!")
log_message("press {.kbd ENTER}")
log_message("address: {.email [e-mail]}")
log_message("URL: {.url https://example.com}")
log_message("Some {.field field}")
log_message("Hello, {.pkg world}!")
log_message("Hello, {.val world}!")

# set indentation
log_message("Hello, world!", level = 2)
log_message("Hello, world!", symbol = "->")
log_message("Hello, %s", "world!", format = TRUE)
log_message("Processing %d items", 42, format = TRUE)

# multiline message
log_message("Line 1\nLine 2\nLine 3", multiline_indent = TRUE)
log_message(
  "Multi-line\ncolored\nmessage",
  text_color = "blue",
  multiline_indent = FALSE
)
log_message(
  "Multi-line\ncolored\nmessage",
  text_color = "blue",
  multiline_indent = FALSE,
  timestamp = FALSE
)

# color formatting
log_message(
  "This is a red message",
  text_color = "red"
)
log_message(
  "This is a message with background",
  back_color = "cyan"
)
log_message(
  "This is a message with both text and background",
  text_color = "red",
  back_color = "cyan"
)
# color formatting also works with `cli_model = FALSE`
log_message(
  "This is a red message",
  text_color = "red",
  cli_model = FALSE
)
log_message(
  "This is a message with background",
  back_color = "cyan",
  cli_model = FALSE
)
log_message(
  "This is a message with both text and background",
  text_color = "red",
  back_color = "cyan",
  cli_model = FALSE
)

thisutils documentation built on July 3, 2025, 9:09 a.m.