R/GLMMstd_dataset.R

In FESta: Fishing Effort Standardization

#' GLMMstd_dataset
#'
#' A fisheries dataset for demonstrating the Generalized Linear
#' Mixed Model (GLMM) based Catch Per Unit Effort (CPUE)
#' standardization method.
#'
#' The dataset contains catch and effort observations collected
#' over multiple years using different fishing gears and vessels.
#' Vessel information is included to model vessel-specific random
#' effects, while year and gear are treated as fixed effects in
#' the CPUE standardization process.
#'
#' @format A data frame with 1000 observations and 5 variables:
#' \describe{
#'   \item{Year}{Fishing year.}
#'   \item{Gear}{Fishing gear used during the fishing operation.}
#'   \item{Vessel}{Unique vessel identifier representing the fishing vessel.}
#'   \item{Effort}{Fishing effort expended during the operation.}
#'   \item{Catch}{Observed catch obtained during the fishing operation.}
#' }
#'
#' @examples
#' \dontrun{
#' library(FESta)
#' data('GLMMstd_dataset')
#' result<-GLMMstd(
#'   data=GLMMstd_dataset,
#'   year_col="Year",
#'   catch_col = "Catch",
#'   effort_col = "Effort",
#'   fixed_effects = c("Year"),
#'   random_effects = c("Vessel"),
#'   log_transform = TRUE
#' )
#' print(result)
#' }
#'
#' @seealso \code{\link{GLMMstd}}
#'
"GLMMstd_dataset"