R/datasets_example.R

In marinebon/ecoidx: Marine ecological indicators R package for CA Current IEA

#' Groundfish diversity
#'
#' Description...
#'
#' @format Format with columns...
#'
#' \itemize{
#'     \item year: ...
#'     \item index: ...
#'     \item SEup: ...
#'     \item SElo: ...
#'     \item timeseries: ...
#'     \item metric: ...
#' }
#'
#' @details Example for more info: More information available at \url{https://noaa-edab.github.io/tech-doc/aquaculture.html}
#' @concept dataset_example
"groundfish"

#' TimeSeries1 example dataset
#'
#' Example of time series data to be used by \code{\link{plot_ts}}
#'
#' @format Format with columns...
#'
#' \itemize{
#'     \item year: integer year \[1985 to 2015\]
#'     \item index: main value (double)
#'     \item SEup: standard error, high
#'     \item SElo: standard error, low
#'     \item timeseries: "(a) Trend and recent mean"
#'     \item metric: "current.data"
#' }
#'
#' @details Example for more info: More information available at \url{https://noaa-edab.github.io/tech-doc/aquaculture.html}
#' @concept dataset_example
"ts1"