Rpath: R implementation of Ecopath with Ecosim

#' AB.params
#'
#' A tutorial ecosystem for teaching Rpath
#'
#' @format An Rpath balanced model object that contains:
#' \describe{
#'   \item{model}{A data.table containing Ecopath unbalanced ecosystem parameters (base parameters and fisheries).}
#'   \item{diet}{A data.table containing the Ecopath model's diet matrix.}
#'   \item{stanzas}{Parameters for multistanza groups.}
#'   \item{pedigree}{A data.table containing the data quality (pedigree) for the Ecopath model.}   
#'   ...
#' }
"AB.params"

#' REco.params
#'
#' A sample ecosystem for Rpath - Anchovy Bay.
#'
#' @format An Rpath balanced model object that contains:
#' \describe{
#'   \item{model}{A data.table containing Ecopath unbalanced ecosystem parameters (base parameters and fisheries).}
#'   \item{diet}{A data.table containing the Ecopath model's diet matrix.}
#'   \item{stanzas}{Parameters for multistanza groups.}
#'   \item{pedigree}{A data.table containing the data quality (pedigree) for the Ecopath model.}   
#'   ...
#' }
"REco.params"

#' Eastern Bering Sea 1990s Ecopath model (53 biological groups and 1 fleet). 
#'
#' Rpath inputs (unbalanaced model).
#'
#' @format An Rpath unbalanced model object that contains:
#' \describe{
#'   \item{model}{A data.table containing Ecopath unbalanced ecosystem parameters (base parameters and fisheries).}
#'   \item{diet}{A data.table containing the Ecopath model's diet matrix.}
#'   \item{stanzas}{Parameters for multistanza groups.}
#'   \item{pedigree}{A data.table containing the data quality (pedigree) for the Ecopath model.}   
#'   ...
#' }
#' @source Whitehouse and Aydin 2020.  Assessing the sensitivity of three Alaska marine food webs to perturbations: an example of Ecosim simulations using Rpath. https://doi.org/10.1016/j.ecolmodel.2020.109074  
"Ecosense.EBS"

#' Gulf of Alaska (west/central) 1990s Ecopath model (49 biological groups and 1 fleet). 
#'
#' Rpath inputs (unbalanaced model).
#'
#' @format An Rpath unbalanced model object that contains:
#' \describe{
#'   \item{model}{A data.table containing Ecopath unbalanced ecosystem parameters (base parameters and fisheries).}
#'   \item{diet}{A data.table containing the Ecopath model's diet matrix.}
#'   \item{stanzas}{Parameters for multistanza groups.}
#'   \item{pedigree}{A data.table containing the data quality (pedigree) for the Ecopath model.}   
#'   ...
#' }
#' @source Whitehouse and Aydin 2020.  Assessing the sensitivity of three Alaska marine food webs to perturbations: an example of Ecosim simulations using Rpath. https://doi.org/10.1016/j.ecolmodel.2020.109074  
"Ecosense.GOA"

#' Eastern Chukchi Sea Ecopath model (52 biological groups and 1 fleet). 
#'
#' Rpath inputs (unbalanaced model).
#'
#' @format An Rpath unbalanced model object that contains:
#' \describe{
#'   \item{model}{A data.table containing Ecopath unbalanced ecosystem parameters (base parameters and fisheries).}
#'   \item{diet}{A data.table containing the Ecopath model's diet matrix.}
#'   \item{stanzas}{Parameters for multistanza groups.}
#'   \item{pedigree}{A data.table containing the data quality (pedigree) for the Ecopath model.}   
#'   ...
#' }
#' @source Whitehouse and Aydin 2020.  Assessing the sensitivity of three Alaska marine food webs to perturbations: an example of Ecosim simulations using Rpath. https://doi.org/10.1016/j.ecolmodel.2020.109074  
"Ecosense.ECS"