R/GAMstd_dataset.R

In FESta: Fishing Effort Standardization

#' GAMstd_dataset
#'
#' A simulated fisheries dataset for demonstrating Generalized
#' Additive Model (GAM) standardization of Catch Per Unit Effort (CPUE).
#'
#' The dataset contains fishing catch and effort observations collected
#' over multiple years together with environmental covariates. The catch
#' values were generated to produce positive log-transformed CPUE values,
#' making the dataset particularly suitable for illustrating the
#' \code{log_transform = TRUE} option in \code{GAMstd()}.
#'
#' The dataset includes temporal, operational, and environmental variables
#' commonly used in fisheries standardization studies. Fishing year and
#' gear type can be treated as fixed effects, while sea surface temperature
#' and fishing depth can be incorporated as smooth terms in the GAM.
#'
#' @format A data frame with 4200 observations and 6 variables:
#' \describe{
#'   \item{Year}{Fishing year.}
#'   \item{Gear}{Fishing gear used during the fishing operation.}
#'   \item{SST}{Sea surface temperature (°C).}
#'   \item{Depth}{Fishing depth (m).}
#'   \item{Effort}{Fishing effort expended during the fishing operation.}
#'   \item{Catch}{Observed catch. Catch values were simulated so that
#'   the resulting CPUE values are generally greater than one, producing
#'   positive log-transformed CPUE values.}
#' }
#'
#'
#' @examples
#' \dontrun{
#' library(FESta)
#' data("GAMstd_dataset")
#' result<-GAMstd(data=GAMstd_dataset,year_col='Year',catch_col='Catch',
#' effort_col='Effort',fixed_effects = c("Year", "Gear"),
#' smooth_terms = c("SST", "Depth"), k=10,log_transform = TRUE)
#' print(result)
#' }
#'
#' @seealso \code{\link{GAMstd}}
"GAMstd_dataset"