assert_numeric_vector

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_numeric_vector 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 numeric vector</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 numeric vector — assert_numeric_vector

<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 numeric vector</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_numeric_vector: Assert input is a numeric vector

Description

Usage

Value

Arguments