args_error_context

Use <code>@inheritParams rlang::args_error_context</code> in your package to
document <code>arg</code> and <code>call</code> arguments (or equivalently their prefixed
versions <code>error_arg</code> and <code>error_call</code>).<ul>
<li><code>arg</code> parameters should be formatted as argument (e.g. using
cli's <code>.arg</code> specifier) and included in error messages. See also
<code>caller_arg()</code>.</li>
<li><code>call</code> parameters should be included in error conditions in a
field named <code>call</code>. An easy way to do this is by passing a <code>call</code>
argument to <code>abort()</code>. See also <code>local_error_call()</code>.</li>
</ul>

A toolbox for working with base types, core R features
like the condition system, and core 'Tidyverse' features like tidy
evaluation.

Lionel Henry

rlang

Functions for Base Types and Core R and 'Tidyverse' Features

Hadley Wickham

mikefc 

Yann Collet

RStudio 

args_error_context function

<dl><dt>arg</dt>
<dd>An argument name as a string. This argument
will be mentioned in error messages as the input that is at the
origin of a problem.</dd>
<dt>error_arg</dt>
<dd>An argument name as a string. This argument
will be mentioned in error messages as the input that is at the
origin of a problem.</dd>
<dt>call</dt>
<dd>The execution environment of a currently
running function, e.g. <code>caller_env()</code>. The function will be
mentioned in error messages as the source of the error. See the
<code>call</code> argument of <code>abort()</code> for more information.</dd>
<dt>error_call</dt>
<dd>The execution environment of a currently
running function, e.g. <code>caller_env()</code>. The function will be
mentioned in error messages as the source of the error. See the
<code>call</code> argument of <code>abort()</code> for more information.</dd></dl>

Arguments

Documentation anchor for error arguments — args_error_context

<dl>

<dt>arg</dt>
<dd>An argument name as a string. This argument
will be mentioned in error messages as the input that is at the
origin of a problem.</dd>


<dt>error_arg</dt>
<dd>An argument name as a string. This argument
will be mentioned in error messages as the input that is at the
origin of a problem.</dd>


<dt>call</dt>
<dd>The execution environment of a currently
running function, e.g. <code>caller_env()</code>. The function will be
mentioned in error messages as the source of the error. See the
<code>call</code> argument of <code>abort()</code> for more information.</dd>


<dt>error_call</dt>
<dd>The execution environment of a currently
running function, e.g. <code>caller_env()</code>. The function will be
mentioned in error messages as the source of the error. See the
<code>call</code> argument of <code>abort()</code> for more information.</dd>

</dl>

args_error_context: Documentation anchor for error arguments

Description

Arguments