R/MGMSstd_dataset.R

In FESta: Fishing Effort Standardization

#' MGMSstd_dataset
#'
#' A simulated multi-gear, multi-species fisheries dataset for illustrating
#' the application of the \code{MGMSstd()} function for multigear mean
#' standardization of Catch Per Unit Effort (CPUE).
#'
#' The dataset contains annual CPUE observations for several fish species
#' captured by different fishing gears over multiple years. It is intended
#' for demonstrating the estimation of nominal and standardized CPUE indices
#' in complex multispecies and multigear fisheries.
#'
#' @format A data frame with 375 observations and 4 variables:
#' \describe{
#'   \item{Year}{Fishing year.}
#'   \item{Gear}{Fishing gear used for harvesting the species.}
#'   \item{Species}{Fish species for which CPUE observations are
#'   available.}
#'   \item{CPUE}{Catch per unit effort corresponding to a particular
#'   species, gear, and year combination.}
#' }
#'
#' @details
#' The dataset represents a hypothetical multigear fishery in which several
#' fishing gears exploit multiple fish species simultaneously. Each row
#' corresponds to the CPUE value for a specific species captured by a
#' particular fishing gear during a given year.
#'
#' The dataset can be used to demonstrate:
#' \itemize{
#'   \item Calculation of gear-specific mean CPUE.
#'   \item Multigear mean standardization.
#'   \item Estimation of nominal and standardized CPUE indices.
#'   \item Visualization of temporal CPUE trends.
#' }
#'
#' @source Simulated dataset generated for illustrating the
#' \code{MGMSstd()} methodology implemented in the FESta package.
#'
#' @examples
#' \dontrun{
#' library(FESta)
#' data("MGMSstd_dataset")
#' result <- MGMSstd(
#'   data = MGMSstd_dataset,
#'   year_col = "Year",
#'   gear_col = "Gear",
#'   species_col = "Species",
#'   cpue_col = "CPUE"
#' )
#'}
#' @keywords datasets
"MGMSstd_dataset"