format_bib

cite_bib

Operates on a named list of <code><a href="/link/bibentry()?package=mlr3misc&version=0.14.0" data-mini-rdoc="mlr3misc::bibentry()">bibentry()</a></code> entries and formats them nicely for
documentation with <a href="https://CRAN.R-project.org/package=roxygen2">roxygen2</a>.<ul>
<li><code>format_bib()</code> is intended to be called in the <code>@references</code> section and
prints the complete entry using <code>toRd()</code>.</li>
<li><code>cite_bib()</code> returns the family name of the first author (if available, falling back
to the complete author name if not applicable) and the year in format
<code>"[LastName] (YYYY)"</code>.</li>
</ul>

Frequently used helper functions and assertions used in
'mlr3' and its companion packages. Comes with helper functions for
functional programming, for printing, to work with 'data.table', as
well as some generally useful 'R6' classes. This package also
supersedes the package 'BBmisc'.

Michel Lang

mlr3misc

Helper Functions for 'mlr3'

Patrick Schratz

format_bib function

<dl><dt>...</dt>
<dd>(<code><a href="/link/character()?package=mlr3misc&version=0.14.0" data-mini-rdoc="mlr3misc::character()">character()</a></code>) 
One or more names of bibentries.</dd>
<dt>bibentries</dt>
<dd>(named <code><a href="/link/list()?package=mlr3misc&version=0.14.0" data-mini-rdoc="mlr3misc::list()">list()</a></code>) 
Named list of bibentries.</dd>
<dt>envir</dt>
<dd>(<code>environment</code>) 
Environment to lookup <code>bibentries</code> if not provided.</dd></dl>

Arguments

Operates on a named list of <code><a href='https://rdrr.io/r/utils/bibentry.html'>bibentry()</a></code> entries and formats them nicely for
documentation with <a href='https://CRAN.R-project.org/package=roxygen2'>roxygen2</a>.<ul>
<li><code>format_bib()</code> is intended to be called in the <code>@references</code> section and
prints the complete entry using <code>toRd()</code>.</li>
<li><code>cite_bib()</code> returns the family name of the first author (if available, falling back
to the complete author name if not applicable) and the year in format
<code>"[LastName] (YYYY)"</code>.</li>
</ul>

Format Bibentries in Roxygen — format_bib

<dl>

<dt>...</dt>
<dd>(<code><a href='https://rdrr.io/r/base/character.html'>character()</a></code>) 
One or more names of bibentries.</dd>


<dt>bibentries</dt>
<dd>(named <code><a href='https://rdrr.io/r/base/list.html'>list()</a></code>) 
Named list of bibentries.</dd>


<dt>envir</dt>
<dd>(<code>environment</code>) 
Environment to lookup <code>bibentries</code> if not provided.</dd>

</dl>

format_bib: Format Bibentries in Roxygen

Description

Usage

Value

Arguments

Examples