R/GLMstd_dataset.R

In FESta: Fishing Effort Standardization

#' GLMstd_dataset
#'
#' A fisheries dataset for demonstrating Generalized Linear
#' Model (GLM) standardization method.
#'
#' The dataset contains catch and effort observations collected
#' over multiple years using different fishing gears. It is
#' intended for illustrating the application of the
#' \code{GLMstd()} function in the FESta package.
#'
#' @format A data frame with 1000 observations and 4 variables:
#' \describe{
#'   \item{Year}{Fishing year.}
#'   \item{Gear}{Fishing gear used during the fishing operation.}
#'   \item{Effort}{Fishing effort expended during the operation.}
#'   \item{Catch}{Observed catch obtained during the fishing operation.}
#' }
#' @examples
#' \dontrun{
#' library(FESta)
#' data('GLMstd_dataset')
#' # Single family
#' result1 <- GLMstd(
#'   data          = GLMstd_dataset,
#'   year_col="Year",
#'   catch_col     = "Catch",
#'   effort_col    = "Effort",
#'   fixed_effects = c("Year", "Gear"),
#'   family_type   = "gamma"
#' )
#' print(result1)
#'
#' # Multiple families - comparison table + tiled plots
#' library(FESta)
#' data('GLMstd_dataset')
#' result2 <- GLMstd(
#'   data          = GLMstd_dataset,
#'   year_col      = "Year",
#'   catch_col     = "Catch",
#'   effort_col    = "Effort",
#'   fixed_effects = c("Year", "Gear"),
#'   family_type   = c("gamma", "lognormal", "tweedie", "poisson", "nbinom","gaussian")
#' )
#' print(result2)
#' }
#' @seealso \code{\link{GLMstd}}
#'
"GLMstd_dataset"