format.errors

Format an <code>errors</code> object for pretty printing.

Support for measurement errors in R vectors, matrices and arrays:
automatic uncertainty propagation and reporting.
Documentation about 'errors' is provided in the paper by Ucar, Pebesma &
Azcorra (2018, <doi:10.32614/RJ-2018-075>), included in this package as a
vignette; see 'citation("errors")' for details.

I<c3><b1>aki Ucar

errors

Uncertainty Propagation for R Vectors

Iñaki Ucar

Lionel Henry

RStudio 

format.errors function

<dl><dt>x</dt>
<dd>an <code>errors</code> object.</dd>
<dt>digits</dt>
<dd>how many significant digits are to be used for uncertainties.
The default, <code>NULL</code>, uses <code>getOption("errors.digits", 1)</code>.
Use <code>digits="pdg"</code> to choose an appropriate number of digits for each
value according to the Particle Data Group rounding rule (see references).</dd>
<dt>scientific</dt>
<dd>logical specifying whether the elements should be
encoded in scientific format.</dd>
<dt>notation</dt>
<dd>error notation; <code>"parenthesis"</code> and <code>"plus-minus"</code>
are supported through the <code>"errors.notation"</code> option.</dd>
<dt>...</dt>
<dd>ignored.</dd></dl>

Arguments

Encode errors — format.errors

<dl>

<dt>x</dt>
<dd>an <code>errors</code> object.</dd>


<dt>digits</dt>
<dd>how many significant digits are to be used for uncertainties.
The default, <code>NULL</code>, uses <code>getOption("errors.digits", 1)</code>.
Use <code>digits="pdg"</code> to choose an appropriate number of digits for each
value according to the Particle Data Group rounding rule (see references).</dd>


<dt>scientific</dt>
<dd>logical specifying whether the elements should be
encoded in scientific format.</dd>


<dt>notation</dt>
<dd>error notation; <code>"parenthesis"</code> and <code>"plus-minus"</code>
are supported through the <code>"errors.notation"</code> option.</dd>


<dt>...</dt>
<dd>ignored.</dd>

</dl>

format.errors: Encode `errors`

Description

Usage

Arguments

References

Examples