add data documentation

NEFSC · Dec 5, 2024 · 768dace · 768dace
1 parent 8061059
commit 768dace
Show file tree

Hide file tree

Showing 4 changed files with 74 additions and 1 deletion.
diff --git 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
@@ -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
diff --git a/man/sst_anomaly.Rd b/man/sst_anomaly.Rd