R/example_inds.R

In dempseydanielle/marindicators: Marine Ecosystem and Fishing Pressure Indicators

#' Indicators calculated from the example data included in the package
#'
#' A dataframe of indicators for AREA1 and AREA2 from 2014 - 2019, calculated
#' from the example data described in this package. Type ?X, ?X_length, ?land,
#' ?species.info, ?species.table, or ?Length_Weight for information on the
#' example data.
#'
#' @format This example data is a dataframe with 12 rows and 114 variables: \describe{
#'   \item{YEAR}{Year for which indicator was calculated} \item{ID}{Area for
#'   which the indicator was calculated} \item{56 Raw Indicators}{Raw values of
#'   Biodiversity, Structure and Functioning, Stability and Resistance,
#'   Potential and Fishing Pressure indicators.} \item{56 Standardized
#'   Indicators}{The same indicators noted above, but standardized using z-score
#'   (subtract mean and divide by standard deviation).} }
#'
#' @source These are example indicators calculated from made-up example data.
"example_inds"