abort_on_invalid_user_action: Constructs a helpful message and signals an error when the...

In Yu-Group/simChef: Intensive Computational Experiments Made Easy

Constructs a helpful message and signals an error when the user takes an invalid action. Can include an optional hint to fix the error.

Description

Constructs a helpful message and signals an error when the user takes an invalid action. Can include an optional hint to fix the error.

Usage

abort_on_invalid_user_action(
  cause_string,
  hint_string = NULL,
  call = rlang::caller_env(),
  ...
)

Arguments

cause_string	Why the action was invalid.
hint_string	An optional hint to fix the error.
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.
...	Passed to simChef::abort().

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