assert_scalar

Assert that an object is a scalar, meaning it is a length 1 atomic vector (such as <code>numeric(1)</code>, <code>character(1)</code> or <code>logical(1)</code>).
Note lists, data.frames and matrices are never considered scalar objects, even if they have only one element.

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

assert_scalar function

<dl><dt>x</dt>
<dd>An object</dd>
<dt>msg</dt>
<dd>A character string containing the error message to display if <code>x</code> is not a scalar</dd>
<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></dl>

Arguments

Assert input is a scalar — assert_scalar

<dl>

<dt>x</dt>
<dd>An object</dd>


<dt>msg</dt>
<dd>A character string containing the error message to display if <code>x</code> is not a scalar</dd>


<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>

</dl>

assert_scalar: Assert input is a scalar

Description

Usage

Value

Arguments

Examples