R/REstd_dataset.R

In FESta: Fishing Effort Standardization

#' REstd_dataset
#'
#' A fisheries dataset for demonstrating the Relative Effort
#' standardization method.
#'
#' The dataset contains catch per unit effort (CPUE), number of
#' fishing boats, and average fishing days for different vessel
#' types operating over multiple years. A standard vessel is used
#' to estimate relative fishing power and compute standardized
#' fishing effort for year-wise CPUE standardization.
#'
#' @format A data frame with 30 observations and 5 variables:
#' \describe{
#'   \item{Year}{Fishing year.}
#'   \item{Vessel}{Vessel type used during the fishing operation.}
#'   \item{Boats}{Number of boats used for fishing.}
#'   \item{Days}{Average number of fishing days.}
#'   \item{CPUE}{Catch per unit effort corresponding to each vessel type.}
#' }
#'
#' @details
#' The dataset consists of observations from three vessel types
#' (A, B, and C) collected over ten years (2016--2025). Vessel A
#' serves as the standard vessel for estimating relative fishing
#' power. The dataset is intended for illustrating the computation
#' of relative fishing power, standardized fishing effort, and
#' year-wise standardized CPUE using the \code{REstd()} function.
#'
#' @examples
#' \dontrun{
#' library(FESta)
#' data("REstd_dataset")
#' result<-REstd(data = REstd_dataset, year_col = "Year", vessel_col = "Vessel",
#'       boats_col = "Boats", days_col = "Days",
#'       cpue_col = "CPUE", standard_vessel = 'A')
#'       print(result)
#' }
#'
#' @seealso \code{\link{REstd}}
"REstd_dataset"