summary_fe_species

Produces a summary for a fe_species object in the same style as R does
factors. Actually, after some conversions <code><a href="/link/summary.factor?package=ForestElementsR&version=2.0.1" data-mini-rdoc="ForestElementsR::summary.factor">summary.factor</a></code> is
called by this function. The species naming in the summary depends on the
parameter <code>spec_lang</code>.

internal

Provides generic data structures and algorithms for use with forest
mensuration data in a consistent framework. The functions and objects
included are a collection of broadly applicable tools. More specialized
applications should be implemented in separate packages that build on this
foundation. Documentation about 'ForestElementsR' is provided by three
vignettes included in this package. For an introduction to the field of
forest mensuration, refer to the textbooks by Kershaw et al. (2017)
<doi:10.1002/9781118902028>, and van Laar and Akca (2007)
<doi:10.1007/978-1-4020-5991-9>.

Peter Biber

ForestElementsR

Data Structures and Functions for Working with Forest Data

Astor Toraño Caicoya

Torben Hilmers

summary_fe_species function

<dl><dt>x</dt>
<dd>Object of one of the supported <code>fe_species_</code> classes</dd>
<dt>spec_lang</dt>
<dd>Choice of how species (group) names or id's are displayed.
Supported choices are "code" (default, displays the species codes as they
are), "eng" (English species names), "ger" (German species names), and
"sci" (scientific species names). The names and the codes refer to the
species coding given in the object's attribute <code>species_coding</code>.</dd>
<dt>maxsum</dt>
<dd>Same as parameter <code>maxsum</code> in <code><a href="/link/summary.factor?package=ForestElementsR&version=2.0.1" data-mini-rdoc="ForestElementsR::summary.factor">summary.factor</a></code></dd></dl>

Arguments

Produces a summary for a fe_species object in the same style as R does
factors. Actually, after some conversions <code><a href='https://rdrr.io/r/base/summary.html'>summary.factor</a></code> is
called by this function. The species naming in the summary depends on the
parameter <code>spec_lang</code>.

Generic Summary for fe_species Objects — summary_fe_species

<dl>

<dt>x</dt>
<dd>Object of one of the supported <code>fe_species_</code> classes</dd>


<dt>spec_lang</dt>
<dd>Choice of how species (group) names or id's are displayed.
Supported choices are "code" (default, displays the species codes as they
are), "eng" (English species names), "ger" (German species names), and
"sci" (scientific species names). The names and the codes refer to the
species coding given in the object's attribute <code>species_coding</code>.</dd>


<dt>maxsum</dt>
<dd>Same as parameter <code>maxsum</code> in <code><a href='https://rdrr.io/r/base/summary.html'>summary.factor</a></code></dd>

</dl>

summary_fe_species: Generic Summary for fe_species Objects

Description

Usage

Value

Arguments