.coerce-params

These parameters are used in multiple coercion functions. They are defined
here to make them easier to import and to find.

internal

A set of consistent, opinionated functions to quickly check
function arguments, coerce them to the desired configuration, or
deliver informative error messages when that is not possible.

Jon Harmon

stbl

Stabilize Function Arguments

.coerce-params function

<dl><dt>...</dt>
<dd>These dots are for future extensions and should be empty.</dd>
<dt>allow_na</dt>
<dd>Logical. Are NA values ok?</dd>
<dt>allow_null</dt>
<dd>Logical. Is NULL an acceptable value?</dd>
<dt>allow_zero_length</dt>
<dd>Logical. Are zero-length vectors acceptable?</dd>
<dt>min_size</dt>
<dd>Integer. The minimum size of the object. Object size will be
tested using <code><a href="https://vctrs.r-lib.org/reference/vec_size.html">vctrs::vec_size()</a></code>.</dd>
<dt>max_size</dt>
<dd>Integer. The maximum size of the object. Object size will be
tested using <code><a href="https://vctrs.r-lib.org/reference/vec_size.html">vctrs::vec_size()</a></code>.</dd>
<dt>x</dt>
<dd>The argument to stabilize.</dd>
<dt>x_arg</dt>
<dd>Character. An argument name for x. The automatic value will work
in most cases, or pass it through from higher-level functions to make error
messages clearer in unexported functions.</dd>
<dt>x_class</dt>
<dd>Character. The class name of <code>x</code> to use in error messages. Use
this if you remove a special class from <code>x</code> before checking its coercion,
but want the error message to match the original class.</dd>
<dt>call</dt>
<dd>The execution environment of the call. See the <code>call</code> argument of
<code><a href="https://rlang.r-lib.org/reference/abort.html">rlang::abort()</a></code> for more information.</dd></dl>

Arguments

Shared parameters — .coerce-params

<dl>

<dt>...</dt>
<dd>These dots are for future extensions and should be empty.</dd>


<dt>allow_na</dt>
<dd>Logical. Are NA values ok?</dd>


<dt>allow_null</dt>
<dd>Logical. Is NULL an acceptable value?</dd>


<dt>allow_zero_length</dt>
<dd>Logical. Are zero-length vectors acceptable?</dd>


<dt>min_size</dt>
<dd>Integer. The minimum size of the object. Object size will be
tested using <code><a href='https://vctrs.r-lib.org/reference/vec_size.html'>vctrs::vec_size()</a></code>.</dd>


<dt>max_size</dt>
<dd>Integer. The maximum size of the object. Object size will be
tested using <code><a href='https://vctrs.r-lib.org/reference/vec_size.html'>vctrs::vec_size()</a></code>.</dd>


<dt>x</dt>
<dd>The argument to stabilize.</dd>


<dt>x_arg</dt>
<dd>Character. An argument name for x. The automatic value will work
in most cases, or pass it through from higher-level functions to make error
messages clearer in unexported functions.</dd>


<dt>x_class</dt>
<dd>Character. The class name of <code>x</code> to use in error messages. Use
this if you remove a special class from <code>x</code> before checking its coercion,
but want the error message to match the original class.</dd>


<dt>call</dt>
<dd>The execution environment of the call. See the <code>call</code> argument of
<code><a href='https://rlang.r-lib.org/reference/abort.html'>rlang::abort()</a></code> for more information.</dd>

</dl>

.coerce-params: Shared parameters

Description

Arguments