rd_info

rd_format_range

rd_format_string

rd_format_packages

(<code>any</code>)
Object of the respective class.

(<code>any)</code>)
Additional arguments.

(<code>numeric(1)</code>)
Lower bound.

lower

(<code>numeric(1)</code>)
Upper bound.

upper

(<code>character()</code>)
Vector of strings.

(<code>character()</code>)
Quotes to use around each element of <code>x</code>.
Will be replicated to lenght 2.

quote

(<code>character()</code>)
Vector of package names.

packages

<code>rd_info()</code> is an internal generic to generate Rd or markdown code to be used in manual pages.
<code>rd_format_string()</code> and <code>rd_format_range()</code> are string functions to assist generating
proper Rd code.

internal

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

rd_info function

<dl><dt>obj</dt>
<dd>(<code>any</code>) 
Object of the respective class.</dd>
<dt>...</dt>
<dd>(<code>any)</code>) 
Additional arguments.</dd>
<dt>lower</dt>
<dd>(<code>numeric(1)</code>) 
Lower bound.</dd>
<dt>upper</dt>
<dd>(<code>numeric(1)</code>) 
Upper bound.</dd>
<dt>str</dt>
<dd>(<code><a href="/link/character()?package=mlr3misc&version=0.10.0" data-mini-rdoc="mlr3misc::character()">character()</a></code>) 
Vector of strings.</dd>
<dt>quote</dt>
<dd>(<code><a href="/link/character()?package=mlr3misc&version=0.10.0" data-mini-rdoc="mlr3misc::character()">character()</a></code>) 
Quotes to use around each element of <code>x</code>.
Will be replicated to lenght 2.</dd>
<dt>packages</dt>
<dd>(<code><a href="/link/character()?package=mlr3misc&version=0.10.0" data-mini-rdoc="mlr3misc::character()">character()</a></code>) 
Vector of package names.</dd></dl>

Arguments

Helpers to Create Manual Pages — rd_info

<dl>

<dt>obj</dt>
<dd>(<code>any</code>) 
Object of the respective class.</dd>


<dt>...</dt>
<dd>(<code>any)</code>) 
Additional arguments.</dd>


<dt>lower</dt>
<dd>(<code>numeric(1)</code>) 
Lower bound.</dd>


<dt>upper</dt>
<dd>(<code>numeric(1)</code>) 
Upper bound.</dd>


<dt>str</dt>
<dd>(<code><a href='https://rdrr.io/r/base/character.html'>character()</a></code>) 
Vector of strings.</dd>


<dt>quote</dt>
<dd>(<code><a href='https://rdrr.io/r/base/character.html'>character()</a></code>) 
Quotes to use around each element of <code>x</code>.
Will be replicated to lenght 2.</dd>


<dt>packages</dt>
<dd>(<code><a href='https://rdrr.io/r/base/character.html'>character()</a></code>) 
Vector of package names.</dd>

</dl>

rd_info: Helpers to Create Manual Pages

Description

Usage

Value

Arguments