as_short_string

This function is intended to be convert any R object to a short descriptive string,
e.g. in <code><a href="/link/base%3A%3Aprint()?package=mlr3misc&version=0.15.1" data-mini-rdoc="mlr3misc::base::print()">base::print()</a></code> functions.
The following rules apply:<ul>
<li>if <code>x</code> is <code>atomic()</code> with length 0 or 1: printed as-is.</li>
<li>if <code>x</code> is <code>atomic()</code> with length greater than 1, <code>x</code> is collapsed with <code>","</code>,
and the resulting string is truncated to <code>trunc_width</code> characters.</li>
<li>if <code>x</code> is an expression: converted to character.</li>
<li>Otherwise: the class is printed.</li>
</ul>If <code>x</code> is a list, the above rules are applied (non-recursively) to its elements.

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

as_short_string function

<dl><dt>x</dt>
<dd>(<code>any</code>) 
Arbitrary object.</dd>
<dt>width</dt>
<dd>(<code>integer(1)</code>) 
Truncate strings to width <code>width</code>.</dd>
<dt>num_format</dt>
<dd>(<code>character(1)</code>) 
Used to format numerical scalars via <code><a href="/link/base%3A%3Asprintf()?package=mlr3misc&version=0.15.1" data-mini-rdoc="mlr3misc::base::sprintf()">base::sprintf()</a></code>.</dd></dl>

Arguments

This function is intended to be convert any R object to a short descriptive string,
e.g. in <code><a href='https://rdrr.io/r/base/print.html'>base::print()</a></code> functions.
The following rules apply:<ul>
<li>if <code>x</code> is <code>atomic()</code> with length 0 or 1: printed as-is.</li>
<li>if <code>x</code> is <code>atomic()</code> with length greater than 1, <code>x</code> is collapsed with <code>","</code>,
and the resulting string is truncated to <code>trunc_width</code> characters.</li>
<li>if <code>x</code> is an expression: converted to character.</li>
<li>Otherwise: the class is printed.</li>
</ul>

If <code>x</code> is a list, the above rules are applied (non-recursively) to its elements.

Convert R Object to a Descriptive String — as_short_string

<dl>

<dt>x</dt>
<dd>(<code>any</code>) 
Arbitrary object.</dd>


<dt>width</dt>
<dd>(<code>integer(1)</code>) 
Truncate strings to width <code>width</code>.</dd>


<dt>num_format</dt>
<dd>(<code>character(1)</code>) 
Used to format numerical scalars via <code><a href='https://rdrr.io/r/base/sprintf.html'>base::sprintf()</a></code>.</dd>

</dl>

as_short_string: Convert R Object to a Descriptive String

Description

Usage

Value

Arguments

Examples