StatusSetter

<p>Internal class that manages authors' status.</p>

internal

Handles and formats author information in scientific writing
in 'R Markdown' and 'Quarto'. 'plume' provides easy-to-use and
flexible tools for inserting author data in 'YAML' as well as
generating author and contribution lists (among others) as strings
from tabular data.

Arnaud Gallou

plume

A Simple Author Handler for Scientific Writing

StatusSetter function

<p><code>plume::NameHandler</code> -&gt; <code>plume::PlumeHandler</code> -&gt; <code>StatusSetter</code></p>

Super classes


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/StatusSetter%24new()?package=plume&version=0.3.0" data-mini-rdoc="plume::StatusSetter$new()"><code>StatusSetter$new()</code></a></p></li>
<li><p><a href="/link/StatusSetter%24set_corresponding_authors()?package=plume&version=0.3.0" data-mini-rdoc="plume::StatusSetter$set_corresponding_authors()"><code>StatusSetter$set_corresponding_authors()</code></a></p></li>
<li><p><a href="/link/StatusSetter%24clone()?package=plume&version=0.3.0" data-mini-rdoc="plume::StatusSetter$clone()"><code>StatusSetter$clone()</code></a></p></li>
</ul></p><p></p></div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="plume" data-topic="PlumeHandler" data-id="data"><a href="/link/plume%3A%3APlumeHandler%24data()?package=plume&version=0.3.0" data-mini-rdoc="plume::plume::PlumeHandler$data()"><code>plume::PlumeHandler$data()</code></a></span></li>
<li><span class="pkg-link" data-pkg="plume" data-topic="PlumeHandler" data-id="get_plume"><a href="/link/plume%3A%3APlumeHandler%24get_plume()?package=plume&version=0.3.0" data-mini-rdoc="plume::plume::PlumeHandler$get_plume()"><code>plume::PlumeHandler$get_plume()</code></a></span></li>
<li><span class="pkg-link" data-pkg="plume" data-topic="PlumeHandler" data-id="get_roles"><a href="/link/plume%3A%3APlumeHandler%24get_roles()?package=plume&version=0.3.0" data-mini-rdoc="plume::plume::PlumeHandler$get_roles()"><code>plume::PlumeHandler$get_roles()</code></a></span></li>
<li><span class="pkg-link" data-pkg="plume" data-topic="PlumeHandler" data-id="print"><a href="/link/plume%3A%3APlumeHandler%24print()?package=plume&version=0.3.0" data-mini-rdoc="plume::plume::PlumeHandler$print()"><code>plume::PlumeHandler$print()</code></a></span></li>
<li><span class="pkg-link" data-pkg="plume" data-topic="PlumeHandler" data-id="roles"><a href="/link/plume%3A%3APlumeHandler%24roles()?package=plume&version=0.3.0" data-mini-rdoc="plume::plume::PlumeHandler$roles()"><code>plume::PlumeHandler$roles()</code></a></span></li>
</ul>
</details></p><p><hr>
<a id="method-StatusSetter-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>StatusSetter$new(..., by)</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-StatusSetter-set_corresponding_authors"></a></p><div class="section" id="method-set-corresponding-authors-">
<h3>Method <code>set_corresponding_authors()</code></h3>
<p>Set corresponding authors.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>StatusSetter$set_corresponding_authors(..., .by = NULL, by = deprecated())</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>...</code></dt>
<dd><p>One or more unquoted expressions separated by commas.
Expressions matching values in the column defined by <code>by</code> or <code>.by</code>
determine corresponding authors. Matching of values is case-insensitive
and dot-agnostic.</p></dd></dl></div></p><p>
<dt><code>.by</code></dt>
<dd><p>Variable used to set corresponding authors. By default, uses
authors' id.</p></dd></p><p>
<dt><code>by</code></dt>
<dd><p><a href="https://lifecycle.r-lib.org/articles/stages.html#deprecated"><img src="figures/lifecycle-deprecated.svg?package=plume&version=0.3.0" alt="[Deprecated]"></a></p>
<p>Please use the <code>.by</code> parameter instead.</p></dd></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>The class instance.</p>
</div><p></p><p></p><p><hr>
<a id="method-StatusSetter-clone"></a></p><div class="section" id="method-clone-">
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>StatusSetter$clone(deep = FALSE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p>
</p>

Methods

StatusSetter class — StatusSetter


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-StatusSetter-new'><code>StatusSetter$new()</code></a></p></li>
<li><p><a href='#method-StatusSetter-set_corresponding_authors'><code>StatusSetter$set_corresponding_authors()</code></a></p></li>
<li><p><a href='#method-StatusSetter-clone'><code>StatusSetter$clone()</code></a></p></li>
</ul>

</div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="plume" data-topic="PlumeHandler" data-id="data"><a href='../../plume/html/PlumeHandler.html#method-PlumeHandler-data'><code>plume::PlumeHandler$data()</code></a></span></li>
<li><span class="pkg-link" data-pkg="plume" data-topic="PlumeHandler" data-id="get_plume"><a href='../../plume/html/PlumeHandler.html#method-PlumeHandler-get_plume'><code>plume::PlumeHandler$get_plume()</code></a></span></li>
<li><span class="pkg-link" data-pkg="plume" data-topic="PlumeHandler" data-id="get_roles"><a href='../../plume/html/PlumeHandler.html#method-PlumeHandler-get_roles'><code>plume::PlumeHandler$get_roles()</code></a></span></li>
<li><span class="pkg-link" data-pkg="plume" data-topic="PlumeHandler" data-id="print"><a href='../../plume/html/PlumeHandler.html#method-PlumeHandler-print'><code>plume::PlumeHandler$print()</code></a></span></li>
<li><span class="pkg-link" data-pkg="plume" data-topic="PlumeHandler" data-id="roles"><a href='../../plume/html/PlumeHandler.html#method-PlumeHandler-roles'><code>plume::PlumeHandler$roles()</code></a></span></li>
</ul>
</details>

<hr>
<a id="method-StatusSetter-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>StatusSetter$new(..., by)</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-StatusSetter-set_corresponding_authors"></a></p><div class='section' id='method-set-corresponding-authors-'>
<h3>Method <code>set_corresponding_authors()</code></h3>
<p>Set corresponding authors.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>StatusSetter$set_corresponding_authors(..., .by = NULL, by = deprecated())</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>...</code></dt>
<dd><p>One or more unquoted expressions separated by commas.
Expressions matching values in the column defined by <code>by</code> or <code>.by</code>
determine corresponding authors. Matching of values is case-insensitive
and dot-agnostic.</p></dd>


<dt><code>.by</code></dt>
<dd><p>Variable used to set corresponding authors. By default, uses
authors' id.</p></dd>


<dt><code>by</code></dt>
<dd><p><a href='https://lifecycle.r-lib.org/articles/stages.html#deprecated'><img src='figures/lifecycle-deprecated.svg' alt='[Deprecated]' /></a></p>
<p>Please use the <code>.by</code> parameter instead.</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>The class instance.</p>
</div>

</div><p><hr>
<a id="method-StatusSetter-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>StatusSetter$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


StatusSetter: StatusSetter class

Description

Arguments

Super classes

Methods

Public methods

Method `new()`

Usage

Method `set_corresponding_authors()`

Usage

Arguments

Returns

Method `clone()`

Usage

Arguments

Description

Arguments

Super classes

Methods

Public methods

Method new()

Usage

Method set_corresponding_authors()

Usage

Arguments

Returns

Method clone()

Usage

Arguments

Method `new()`

Method `set_corresponding_authors()`

Method `clone()`