# Data Structures and Functions for Working with Forest Data

## Documentation for package ‘ForestElementsR’ version 3.0.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

A C D E F G H I M N P S V W Y

## -- A --

age_d_gnfi3 | Inverse Stem Diameter Growth Model of the 3rd German National Forest Inventory (2012)
age_h_gnfi3 | Inverse Tree Height Growth Model of the 3rd German National Forest Inventory (2012)
assmann_layers | Attribute Tree Heights to Layers After Ernst Assmann
as_fe_species_bavrn_state | Cast Appropriate Objects Into a *fe_stand_bavrn_state* Species Class Object
as_fe_species_bavrn_state_short | Cast Appropriate Objects Into a *fe_stand_bavrn_state_short* Species Class Object
as_fe_species_ger_nfi_2012 | Cast Appropriate Objects Into a *fe_stand_ger_nfi_2012* Species Class Object
as_fe_species_master | Cast Appropriate Objects Into a *fe_stand_master* Species Class Object
as_fe_species_tum_wwk_long | Cast Appropriate Objects Into a *fe_species_tum_wwk_long* Species Class Object
as_fe_species_tum_wwk_short | Cast Appropriate Objects Into a *fe_stand_tum_wwk_short* Species Class Object

## -- C --

cast_overrides_from_csv | Build a Cast-Override Table from a CSV
coding_table_from_template | Build a Species Coding Table from a Filled Template
coding_template_from_master | Create a Template for Building a Species Coding Table
crown_diameter_silva | Estimate a tree's crown diameter

## -- D --

d_100 | Dominant Diameter d100
d_age_gnfi3 | Estimate Stem Diameter Growth With the 3rd German National Forest Inventory Growth Model (2012)
d_dom_weise | Weise's Dominant Diameter
d_q | Quadratic Mean Diameter

## -- E --

european_beech_1_fe_stand | Example Stands
european_beech_1_raw | Example Stands
example_data | Example Stands

## -- F --

fe_ccircle_spatial | User Friendly Construction of an *fe_ccircle_spatial* Object from a List of Data Frames
fe_ccircle_spatial_notrees | User Friendly Construction of an *fe_ccircle_spatial_notrees* Object from a List of Data Frames
fe_species_bavrn_state | Construct a _fe_species_bavrn_state_ Species Code Vector
fe_species_bavrn_state_short | Construct a _fe_species_bavrn_state_short_ Species Code Vector
fe_species_ger_nfi_2012 | Construct a _fe_species_ger_nfi_2012_ Species Code Vector
fe_species_get_coding | Get Name of the Coding Belonging to an *fe_species* Object
fe_species_get_coding_table | Get the Coding Table of a Supported *fe_species* Coding
fe_species_get_field_table | Field Lookup Table of a Species Coding
fe_species_is_tree | Test Which Elements of a Species Code Vector Denote Tree Species
fe_species_master | Construct a _fe_species_master_ Species Code Vector
fe_species_non_tree_codes | Non-Tree Codes of a Species Coding
fe_species_tum_wwk_long | Construct a _fe_species_tum_wwk_long_ Species Code Vector
fe_species_tum_wwk_short | Construct a _fe_species_tum_wwk_short_ Species Code Vector
fe_stand | User Friendly Construction of an *fe_stand* Object from a Data Frame
fe_stand_spatial | User Friendly Construction of an *fe_stand_spatial* Object from a List of Data Frames
fe_yield_table | User Friendly Construction of an *fe_yield_table* Object from a Data Frame
fe_ytable_ash_wimmenauer_1919_29 | Yield Tables
fe_ytable_beech_gehrhardt_moderate_1908 | Yield Tables
fe_ytable_beech_wiedemann_moderate_1931 | Yield Tables
fe_ytable_birch_schwappach_1903_29 | Yield Tables
fe_ytable_blackalder_mitscherlich_heavy_1945 | Yield Tables
fe_ytable_douglas_schober_moderate_1956 | Yield Tables
fe_ytable_japanlarch_schober_moderate_1953 | Yield Tables
fe_ytable_larch_schober_moderate_1946 | Yield Tables
fe_ytable_oak_juettner_moderate_1955 | Yield Tables
fe_ytable_pine_gehrhardt_moderate_1921 | Yield Tables
fe_ytable_pine_wiedemann_moderate_1943 | Yield Tables
fe_ytable_poplar_blume_1949 | Yield Tables
fe_ytable_redoak_bauer_1955 | Yield Tables
fe_ytable_silver_fir_hausser_moderate_1956 | Yield Tables
fe_ytable_spruce_assmann_franz_mean_yield_level_1963 | Yield Tables
fe_ytable_spruce_gehrhardt_moderate_1921 | Yield Tables
fe_ytable_spruce_guttenberg_1915 | Yield Tables
fe_ytable_spruce_vanselow_1951 | Yield Tables
fe_ytable_spruce_wiedemann_moderate_1936_42 | Yield Tables
format.fe_species_bavrn_state | Formatted Output of an *fe_species_bavrn_state* Vector
format.fe_species_bavrn_state_short | Formatted Output of an *fe_species_bavrn_state_short* Vector
format.fe_species_ger_nfi_2012 | Formatted Output of an *fe_species_ger_nfi_2012* Vector
format.fe_species_master | Formatted Output of an *fe_species_master* Vector
format.fe_species_tum_wwk_long | Formatted Output of an *fe_species_tum_wwk_long* Vector
format.fe_species_tum_wwk_short | Formatted Output of an *fe_species_tum_wwk_short* Vector

## -- G --

get_area_ha | Get the Area in ha of a Compatible Object
get_center | Obtaining Center Coordinates of Spatial 'fe_stand' Child Objects

## -- H --

height_crown_base_silva | Estimate a tree's height to crown base
h_100 | Dominant Height h100
h_age_gnfi3 | Estimate Tree Height Growth With the 3rd German National Forest Inventory Growth Model (2012)
h_dom_weise | Weise's Dominant Height
h_q | Quadratic Mean Height
h_q_from_d_q | Estimate Quadratic Mean Height from Quadratic Mean Diameter
h_standard_bv | Calculate Tree Heights with the Bavarian Standard Height Curve System
h_standard_gnfi3 | Calculate Tree Heights with the Bavarian Standard Height Curve System of the 3rd German National Forest Inventory (2012)

## -- I --

is_fe_ccircle_spatial | Check if an Object is an *fe_ccircle_spatial*
is_fe_ccircle_spatial_notrees | Check if an Object is an *fe_ccircle_spatial_notrees* object
is_fe_species_bavrn_state | Check if an Object is a *fe_species_bavrn_state* species code vector
is_fe_species_bavrn_state_short | Check if an Object is a *fe_species_bavrn_state_short* species code vector
is_fe_species_ger_nfi_2012 | Check if an Object is a *fe_species_ger_nfi_2012* species code vector
is_fe_species_master | Check if an Object is a *fe_species_master* species code vector
is_fe_species_tum_wwk_long | Check if an Object is a *fe_species_tum_wwk_long* species code vector
is_fe_species_tum_wwk_short | Check if an Object is a *fe_species_tum_wwk_short* species code vector
is_fe_stand | Check if an Object is an *fe_stand*
is_fe_stand_spatial | Check if an Object is an *fe_stand_spatial*
is_fe_yield_table | Check if an Object is an *fe_yield_table*

## -- M --

master_table_from_csv | Build the Species Master Table from a CSV
master_template_csv | Write the Species Master Table as a CSV Template
mm_forest_1_fe_stand_spatial | Example Stands
mm_forest_1_raw | Example Stands

## -- N --

new_fe_ccircle_spatial | Constructor for the *fe_ccircle_spatial* Class
new_fe_ccircle_spatial_notrees | Constructor for the *fe_ccircle_spatial_notrees* Class
new_fe_species_bavrn_state | Constructor for the *fe_species_bavrn_state* Class
new_fe_species_bavrn_state_short | Constructor for the *fe_species_bavrn_state_short* Class
new_fe_species_ger_nfi_2012 | Constructor for the *fe_species_ger_nfi_2012* Class
new_fe_species_master | Constructor for the *fe_species_master* Class
new_fe_species_tum_wwk_long | Constructor for the *fe_species_tum_wwk_long* Class
new_fe_species_tum_wwk_short | Constructor for the *fe_species_tum_wwk_short* Class
new_fe_stand | Constructor for the *fe_stand* Class
new_fe_stand_spatial | Constructor for the *fe_stand_spatial* Class
new_fe_yield_table | Constructor for the *fe_yield_table* Class
norway_spruce_1_fe_stand | Example Stands
norway_spruce_1_raw | Example Stands
n_rep_ha | Calculate or Return the Representation Number per ha for the Trees Contained in a Compatible Object

## -- P --

plot.fe_ccircle_spatial | Plot an fe_ccircle_spatial Object
plot.fe_ccircle_spatial_notrees | Plot an fe_ccircle_spatial_notrees Object
plot.fe_stand | Plot an *fe_stand* Object
plot.fe_yield_table | Plot an fe_yield_table Object

## -- S --

selection_forest_1_fe_stand | Example Stands
selection_forest_1_raw | Example Stands
se_tests | Convenient Information About the Precision of a Random Sample
shannon_index | Shannon Diversity Index for Tree Species
site_index | Find Site Indexes With a Yield Table
si_to_mai_age | Convert a Standard Site Index Into an MAI(age) Site Index
si_to_mai_max | Convert a Standard Site Index Into an maximum MAI Site Index
species_cast_overrides | Declarative Registry of Species Coding Cast Overrides
species_codings | Supported Species Codings in the Package *ForestElementsR*
species_master_table | List of Supported Species in the Package *ForestElementsR*
species_profile | Species Profile Index After Pretzsch
species_shares | species_shares
spruce_beech_1_fe_stand | Example Stands
spruce_beech_1_raw | Example Stands
spruce_pine_ccircle_raw | Example Stands
spruce_pine_ccircle_spatial | Example Stands
spruce_pine_ccircle_spatial_notrees | Example Stands
standing_area_gnfi3 | Estimate the Standing Area of Single Trees
stand_level_increment | stand_level_increment
stand_sums_dynamic | stand_sums_dynamic
stand_sums_static | Static Stand Sum and Mean Values for an fe_stand Object
stocking_level | Calculate the Stocking Level ("Bestockungsgrad") of a Stand
summary.fe_ccircle_spatial_notrees | summary For a fe_ccircle_spatial_notrees object
summary.fe_species_bavrn_state | Summary of an *fe_species_bavrn_state* Vector
summary.fe_species_bavrn_state_short | Summary of an *fe_species_bavrn_state_short* Vector
summary.fe_species_ger_nfi_2012 | Summary of an *fe_species_ger_nfi_2012* Vector
summary.fe_species_master | Summary of an *fe_species_master* Vector
summary.fe_species_tum_wwk_long | Summary of an *fe_species_tum_wwk_long* Vector
summary.fe_species_tum_wwk_short | Summary of an *fe_species_tum_wwk_short* Vector
summary.fe_stand | Summary for an *fe_stand* Object
survey_overview | Generate an Overview of the Surveys of an fe_stand Object

## -- V --

validate_fe_ccircle_spatial | Validate an *fe_ccircle_spatial* Object
validate_fe_ccircle_spatial_notrees | Validate an *fe_ccircle_spatial_notrees* Object
validate_fe_species_bavrn_state | Validate an _fe_species_bavrn_state_ Object
validate_fe_species_bavrn_state_short | Validate an _fe_species_bavrn_state_short_ Object
validate_fe_species_ger_nfi_2012 | Validate an _fe_species_ger_nfi_2012_ Object
validate_fe_species_master | Validate an _fe_species_master_ Object
validate_fe_species_tum_wwk_long | Validate an _fe_species_tum_wwk_long_ Object
validate_fe_species_tum_wwk_short | Validate an _fe_species_tum_wwk_short_ Object
validate_fe_stand | Validate an *fe_stand* Object
validate_fe_stand_spatial | Validate an *fe_stand_spatial* Object
validate_fe_yield_table | Validate a Candidate For an fe_yield_table Object
vec_ptype_abbr.fe_species_bavrn_state | Abbreviation for the _fe_species_bavrn_state_ Type
vec_ptype_abbr.fe_species_bavrn_state_short | Abbreviation for the _fe_species_bavrn_state_short_ Type
vec_ptype_abbr.fe_species_ger_nfi_2012 | Abbreviation for the _fe_species_ger_nfi_2012_ Type
vec_ptype_abbr.fe_species_master | Abbreviation for the _fe_species_master_ Type
vec_ptype_abbr.fe_species_tum_wwk_long | Abbreviation for the _fe_species_tum_wwk_long_ Type
vec_ptype_abbr.fe_species_tum_wwk_short | Abbreviation for the _fe_species_tum_wwk_short_ Type
v_gri | Calculate Tree Volumes With the GRI Volume Equations (Franz et al. 1973)
v_red_harvest_ubark | Reduce a Given standing Volume Over Bark to Harvested Volume Under Bark

## -- W --

wood_density_tum_wwk_short | Basic Wood Density Values for the _tum_wwk_short_ Species Coding

## -- Y --

yield_tables | Yield Tables
yield_tables_for_species | Yield Tables To Species Assignments
ytables_bavrn_state_short_var_1 | Yield Tables To Species Assignments
ytables_bavrn_state_var_1 | Yield Tables To Species Assignments
ytables_tum_wwk_short_var_1 | Yield Tables To Species Assignments
ytable_age_slice | Take an Age Slice out of an fe_yield_table_object
ytable_lookup | Look Up Values From Yield Tables
ytable_max_slice | Take a Max Slice out of an fe_yield_table_object
ytable_pine_wiedemann_moderate_1943_raw | Yield Tables