common_roxygen_params

Provides simple assertions with sensible defaults and customisable error messages.
It offers convenient assertion call wrappers and a general assert function that can handle any condition.
Default error messages are user friendly and easily customized with inline code evaluation and styling powered by the 'cli' package.

Sam El-Kamand

assertions

Simple Assertions for Beautiful and Customisable Error Messages

common_roxygen_params function

<dl><dt>call</dt>
<dd>Only relevant when pooling assertions into multi-assertion helper functions. See <a href="https://cli.r-lib.org/reference/cli_abort.html">cli_abort</a> for details.</dd>
<dt>arg_name</dt>
<dd>Advanced use only. Name of the argument passed (default: NULL, will automatically extract arg_name).</dd>
<dt>msg</dt>
<dd>The error message thrown if the assertion fails (string)</dd>
<dt>...</dt>
<dd>Used to pass any arguments to assertion function</dd></dl>

Arguments

Common Parameter Descriptions — common_roxygen_params

<dl>

<dt>call</dt>
<dd>Only relevant when pooling assertions into multi-assertion helper functions. See <a href='https://cli.r-lib.org/reference/cli_abort.html'>cli_abort</a> for details.</dd>


<dt>arg_name</dt>
<dd>Advanced use only. Name of the argument passed (default: NULL, will automatically extract arg_name).</dd>


<dt>msg</dt>
<dd>The error message thrown if the assertion fails (string)</dd>


<dt>...</dt>
<dd>Used to pass any arguments to assertion function</dd>

</dl>

common_roxygen_params: Common Parameter Descriptions

Description

Usage

Arguments