R/sppEquivalencies_CA.R

In PredictiveEcology/LandR: Landscape Ecosystem Modelling in R

#' Table of species name equivalencies for Canadian trees
#'
#' A table containing the different species names used across different sources (e.g., LANDIS-II
#' test parameter files and trait tables, the LandR standard, kNN species biomass layers, etc.).
#' Each column refers to a different source or species naming approach.
#' Presently only containing Canadian native tree species, with name equivalencies coming from:
#' \itemize{
#'   \item LANDIS-II test parameter tables (column `LANDIStest_names`;
#'         source: <https://raw.githubusercontent.com/LANDIS-II-Foundation/Extensions-Succession/master/biomass-succession-archive/trunk/tests/v6.0-2.0/species.txt>);
#'   \item LANDIS-II Canada-wide trait table (column `LANDIStraits_names`;
#'         source: <https://raw.githubusercontent.com/dcyr/LANDIS-II_IA_generalUseFiles/master/speciesTraits.csv>);
#'   \item LandR family of SpaDES modules (column `LandR_names`;
#'   \item CFS kNN species biomass layers (column `KNN_names`;
#'         source: <http://tree.pfc.forestry.ca/kNN-Species.tar>);
#'   \item Canadian Common Attribute Schema for Forest Resource Inventories (column `CASFRI_names`;
#'         source <http://www.borealbirds.ca/files/CAS_Document_Final_Mar_2010_ALL_APPENDICES.pdf>).
#' }
#'
#' Remaining columns have been filled with some other useful ways to name species (e.g., for plotting).
#'
#' This table is currently used as the default equivalencies table in LandR SpaDES modules,
#' but can also serve as a template to customize species names equivalencies by the user.
#'
#' @format A `data.frame` with 271 rows and 10 variables:
#' \describe{
#'   \item{LANDIS_test}{species names from LANDIS-II test parameter table}
#'   \item{LANDIS_traits}{species names from LANDIS-II traits parameter table}
#'   \item{LandR}{species names from LandR modules}
#'   \item{KNN}{species names from kNN datasets}
#'   \item{CASFRI}{species names from CASFRI database}
#'   \item{Latin_full}{accepted species latin names as in <http://theplantlist.org>}
#'   \item{EN_generic_short}{Short version of species' common names in English}
#'   \item{EN_generic_full}{Full species common names in English}
#'   \item{Leading}{Simple common English names used for leading species}
#'   \item{Notes}{additional notes and information}
#'   \item{Boreal}{Species present in the Boreal forests of Canada}
#'   \item{Type}{Whether the species is a deciduous or conifer species}
#'   \item{PSP}{species name from the module ianmseddy/PSP_Clean}
#'   \item{BC_Forestry}{the species code adopted by the Government of British Columbia}
#'   \item{FuelClass}{The fuel class used by the module PredictiveEcology/fireSense}#'
#' }
#'
"sppEquivalencies_CA"