gbort: Custom error message

gbortR Documentation

Custom error message

Description

Throw abort with format_error

Usage

gbort(
  message = NULL,
  class = NULL,
  ...,
  trace = rlang::trace_back(bottom = 2),
  parent = NULL,
  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.

class

(class) Subclass of the condition

trace

(trace) A trace object created by trace_back

parent

(cond) Supply parent when you rethrow an error from a condition handler

e

(environment) calling environment. Passed to glue for making the message

See Also

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


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