fe_species_tum_wwk_short: Construct a _fe_species_tum_wwk_short_ Species Code Vector

In ForestElementsR: Data Structures and Functions for Working with Forest Data

Construct a fe_species_tum_wwk_short Species Code Vector

Description

User interface for constructing a vector of species codes follwing the fe_species_tum_wwk_short convention

Usage

fe_species_tum_wwk_short(x = character())

Arguments

x

Input vector to become a vector of tree species codes by the definition tum_wwk_short. Any type of vector (typically integer) which, after conversion with as.character, adheres to that definition is acceptable. If x is provided as a character vector, leading and trailing white spaces will be trimmed.

Details

The tum_wwk_short species coding is one of two codings in use at the Chair of Forest Growth and Yield Science. It defines only a small set of single species explicitly (the most important ones in Central Europe), while all other species are attributed to three large container groups. See the example section for how to look up the coding.

Value

If the user input allows to construct a well-defined fe_species_tum_wwk_short object, this object will be returned. If not, the function will terminate with an error.

Examples

# Libraries required for the following two examples
library(dplyr)
library(purrr)

# Look up the tum_wwk_short species codes for all supported species
# the column species_id contains the tum_wwk_short codes
species_codings |>
  filter(species_coding == "tum_wwk_short") |>
  pluck(2, 1) |>
  print(n = Inf)

# Display a summary table which shows the number of single species behind
# each tum_wwk_short species code
species_codings |>
  filter(species_coding == "tum_wwk_short") |>
  pluck(2, 1) |>
  group_by(name_eng, species_id) |> # display english names
  summarise(n = n()) |>
  arrange(as.numeric(species_id)) |> # just for the look of it
  print(n = Inf)


# Make an fe_species_tum_wwk_short vector from a vector of integer codes
spec_ids <- fe_species_tum_wwk_short(c(1, 1, 1, 5, 5, 5, 5, 3, 3, 8, 9, 8))

ForestElementsR documentation built on April 3, 2025, 7:47 p.m.