gwarn: Custom warning message

In yogat3ch/UU: Universally Useful

Custom warning message

Description

Throw cli_alert_warning with format_warning

Usage

gwarn(
  message = NULL,
  body = NULL,
  footer = NULL,
  .frequency = c("always", "regularly", "once"),
  e = rlang::caller_env()
)

Arguments

message	(chr) The message to display, formatted as a bulleted list. The first element is displayed as an alert bullet prefixed with ! by default. Elements named "*", "i", and "x" are formatted as regular, info, and cross bullets respectively. See topic-condition-formatting for more about bulleted messaging.
body, footer	Additional bullets.
.frequency	How frequently should the warning or message be displayed? By default ("always") it is displayed at each time. If "regularly", it is displayed once every 8 hours. If "once", it is displayed once per session.
e	(environment) calling environment. Passed to glue for making the message

See Also

Other condition signaling: gbort(), ginfo(), gmsg(), trace_back_json()

yogat3ch/UU documentation built on May 31, 2024, 10:14 p.m.