From 768dace69562cf5e86da88cf9c4e81f6d1d3cea3 Mon Sep 17 00:00:00 2001 From: Abby Tyrell <77738923+atyrell3@users.noreply.github.com> Date: Thu, 5 Dec 2024 10:13:12 -0500 Subject: [PATCH] add data documentation --- DESCRIPTION | 2 +- R/data.R | 23 +++++++++++++++++++++++ man/new_sst_anomaly.Rd | 25 +++++++++++++++++++++++++ man/sst_anomaly.Rd | 25 +++++++++++++++++++++++++ 4 files changed, 74 insertions(+), 1 deletion(-) create mode 100644 R/data.R create mode 100644 man/new_sst_anomaly.Rd create mode 100644 man/sst_anomaly.Rd diff --git a/DESCRIPTION b/DESCRIPTION index 5ea36fe..f12f218 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -13,6 +13,6 @@ License: `use_mit_license()`, `use_gpl3_license()` or friends to pick a Encoding: UTF-8 LazyData: true Roxygen: list(markdown = TRUE) -RoxygenNote: 7.2.1 +RoxygenNote: 7.2.3 Depends: R (>= 2.10) diff --git a/R/data.R b/R/data.R new file mode 100644 index 0000000..c7d8da9 --- /dev/null +++ b/R/data.R @@ -0,0 +1,23 @@ +#' @title SST anomaly using long-term mean from 1991-2020 +#' @description SST anomaly using long-term mean from 1991-2020 +#' @format A data frame with 513 rows and 4 variables: +#' \describe{ +#' \item{\code{Year}}{double Year} +#' \item{\code{EPU}}{character Ecological Production Unit} +#' \item{\code{Var}}{character Indicator name} +#' \item{\code{Value}}{double Anomaly value (degrees C)} +#'} +#' @details DETAILS +"new_sst_anomaly" + +#' @title SST anomaly using long-term mean from 1982-2010 +#' @description SST anomaly using long-term mean from 1982-2010 +#' @format A data frame with 513 rows and 4 variables: +#' \describe{ +#' \item{\code{Year}}{double Year} +#' \item{\code{EPU}}{character Ecological Production Unit} +#' \item{\code{Var}}{character Indicator name} +#' \item{\code{Value}}{double Anomaly value (degrees C)} +#'} +#' @details DETAILS +"sst_anomaly" diff --git a/man/new_sst_anomaly.Rd b/man/new_sst_anomaly.Rd new file mode 100644 index 0000000..919614f --- /dev/null +++ b/man/new_sst_anomaly.Rd @@ -0,0 +1,25 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/data.R +\docType{data} +\name{new_sst_anomaly} +\alias{new_sst_anomaly} +\title{SST anomaly using long-term mean from 1991-2020} +\format{ +A data frame with 513 rows and 4 variables: +\describe{ +\item{\code{Year}}{double Year} +\item{\code{EPU}}{character Ecological Production Unit} +\item{\code{Var}}{character Indicator name} +\item{\code{Value}}{double Anomaly value (degrees C)} +} +} +\usage{ +new_sst_anomaly +} +\description{ +SST anomaly using long-term mean from 1991-2020 +} +\details{ +DETAILS +} +\keyword{datasets} diff --git a/man/sst_anomaly.Rd b/man/sst_anomaly.Rd new file mode 100644 index 0000000..08af92f --- /dev/null +++ b/man/sst_anomaly.Rd @@ -0,0 +1,25 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/data.R +\docType{data} +\name{sst_anomaly} +\alias{sst_anomaly} +\title{SST anomaly using long-term mean from 1982-2010} +\format{ +A data frame with 513 rows and 4 variables: +\describe{ +\item{\code{Year}}{double Year} +\item{\code{EPU}}{character Ecological Production Unit} +\item{\code{Var}}{character Indicator name} +\item{\code{Value}}{double Anomaly value (degrees C)} +} +} +\usage{ +sst_anomaly +} +\description{ +SST anomaly using long-term mean from 1982-2010 +} +\details{ +DETAILS +} +\keyword{datasets}