local_use_cli

<a href="https://lifecycle.r-lib.org/articles/stages.html#experimental"><img src="figures/lifecycle-experimental.svg?package=rlang&version=1.1.2" alt="[Experimental]"></a>
<code>local_use_cli()</code> marks a package namespace or the environment of a
running function with a special flag that instructs <code>abort()</code> to
use cli to format error messages. This formatting happens lazily,
at print-time, in various places:<ul>
<li>When an unexpected error is displayed to the user.</li>
<li>When a captured error is printed in the console, for instance via
<code>last_error()</code>.</li>
<li>When <code><a href="/link/conditionMessage()?package=rlang&version=1.1.2" data-mini-rdoc="rlang::conditionMessage()">conditionMessage()</a></code> is called.</li>
</ul>cli formats messages and bullets with indentation and
width-wrapping to produce a polished display of messages.

internal

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

Posit, PBC 

local_use_cli function

<dl><dt>...</dt>
<dd>These dots are for future extensions and must be empty.</dd>
<dt>format</dt>
<dd>Whether to use cli at print-time to format messages
and bullets.</dd>
<dt>inline</dt>
<dd><a href="https://lifecycle.r-lib.org/articles/stages.html#experimental"><img src="figures/lifecycle-experimental.svg?package=rlang&version=1.1.2" alt="[Experimental]"></a> Whether to use
cli at throw-time to format the inline parts of a message. This
makes it possible to use cli interpolation and formatting with
<code>abort()</code>.</dd>
<dt>frame</dt>
<dd>A package namespace or an environment of a running
function.</dd></dl>

Arguments

To use cli formatting automatically in your package:<ol>
<li>Make sure <code>run_on_load()</code> is called from your <code>.onLoad()</code> hook.</li>
<li>Call <code>on_load(local_use_cli())</code> at the top level of your namespace.</li>
</ol>It is also possible to call <code>local_use_cli()</code> inside a running
function, in which case the flag only applies within that function.

Usage

<a href='https://lifecycle.r-lib.org/articles/stages.html#experimental'><img src='figures/lifecycle-experimental.svg' alt='[Experimental]' /></a>
<code>local_use_cli()</code> marks a package namespace or the environment of a
running function with a special flag that instructs <code>abort()</code> to
use cli to format error messages. This formatting happens lazily,
at print-time, in various places:<ul>
<li>When an unexpected error is displayed to the user.</li>
<li>When a captured error is printed in the console, for instance via
<code>last_error()</code>.</li>
<li>When <code><a href='https://rdrr.io/r/base/conditions.html'>conditionMessage()</a></code> is called.</li>
</ul>

cli formats messages and bullets with indentation and
width-wrapping to produce a polished display of messages.

Use cli to format error messages — local_use_cli

<dl>

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


<dt>format</dt>
<dd>Whether to use cli at print-time to format messages
and bullets.</dd>


<dt>inline</dt>
<dd><a href='https://lifecycle.r-lib.org/articles/stages.html#experimental'><img src='figures/lifecycle-experimental.svg' alt='[Experimental]' /></a> Whether to use
cli at throw-time to format the inline parts of a message. This
makes it possible to use cli interpolation and formatting with
<code>abort()</code>.</dd>


<dt>frame</dt>
<dd>A package namespace or an environment of a running
function.</dd>

</dl>

To use cli formatting automatically in your package:<ol>
<li>Make sure <code>run_on_load()</code> is called from your <code>.onLoad()</code> hook.</li>
<li>Call <code>on_load(local_use_cli())</code> at the top level of your namespace.</li>
</ol>

It is also possible to call <code>local_use_cli()</code> inside a running
function, in which case the flag only applies within that function.

local_use_cli: Use cli to format error messages

Description

Usage

Arguments

Usage