R/data.R

In zac-driscoll/trout.modlR: Analyzes Great Lakes Trout Model Data

#' Parameter Lookup Table
#'
#' This table lists all of the available options for the \code{get_parameter}
#' and \code{get_parameter} functions. A description is provided for each
#' option.
#'
#' @format \code{parameter_names} is a data.frame with 24 rows and 2 variables as
#' follows:
#' \describe{
#'   \item{param_name}{Name of parameter. This can be supplied to
#'         \code{get_parameter} and \code{get_parameter}}
#'   \item{descriptions}{A text description of the parameters}
#' }
#' @name parameter_names
#'
#' @source parameter_names-- Built by hand for trout.modlR
"parameter_names"

#' Whitefish Model Output1
#'
#' Whitefish data output from an ADMB model. Used within the package as
#' example data for testing.
#'
#' @format \code{whitefish1} is a list with 56 elements
#' @name whitefish1
#'
#' @source ADMB model output
"whitefish1"


#' Whitefish Model Output2
#'
#' Lake trout data output from an ADMB model. Used within the package as
#' example data for testing.
#'
#' @format \code{whitefish2} is a list with 56 elements
#' @name whitefish2
#'
#' @source ADMB model output
"whitefish2"

#' Lake Trout Model output1
#'
#' Lake trout data output from an ADMB model. Used within the package as
#' example data for testing.
#'
#' @format \code{trout1} is a list with 44 elements
#' @name trout1
#'
#' @source ADMB model output
"trout1"

#' Lake Trout Model output2
#'
#' Lake trout data output from an ADMB model. Used within the package as
#' example data for testing.
#'
#' @format \code{trout2} is a list with 44 elements
#' @name trout2
#'
#' @source ADMB model output
"trout2"

#' Lake Trout Model output3
#'
#' Lake trout data output from an ADMB model. Used within the package as
#' example data for testing.
#'
#' @format \code{trout3} is a list with 44 elements
#' @name trout3
#'
#' @source ADMB model output
"trout3"


#' Custom Palettes
#'
#' Custom palettes to use for the trout.modlR package
#'
#' @format \code{custom_palettes}
#' @name custom_palettes
#'
#' @source Made for pacakge
"custom_palettes"