inform: Signals a message with default subclass "simChef_message".

View source: R/signals.R

informR Documentation

Signals a message with default subclass "simChef_message".

Description

Signals a message with default subclass "simChef_message".

Usage

inform(
  message = NULL,
  class = "simChef_message",
  call = rlang::caller_env(),
  ...
)

Arguments

message

Message to include with the condition.

class

Subclass passed to the appropriate rlang signal function.

call

The function environment that is most relevant from the user's perspective. Default is rlang::caller_env(), which gives the environment attached to the function that called this signal function.

...

Additional arguments to pass to the appropriate rlang signal function.


Yu-Group/simChef documentation built on March 25, 2024, 3:22 a.m.