Use more inherited Roxygen tags

ropensci · Dec 17, 2024 · eec6c74 · eec6c74
1 parent b729a85
commit eec6c74
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 15 deletions.
diff --git a/R/create_CRU_df.R b/R/create_CRU_df.R
@@ -57,8 +57,8 @@
 #' @seealso
 #' [get_CRU_df].
 #'
-#' @return A \CRANpkg{data.table} object of \acronym{CRU} \acronym{CL} v. 2.0
-#'  climatology elements.
+#' @return A [data.table::data.table] object of \acronym{CRU} \acronym{CL} v.
+#'  2.0 climatology elements.
 #'
 #' @author Adam H Sparks, \email{adamhsparks@@gmail.com}
 #'

diff --git a/R/get_CRU_df.R b/R/get_CRU_df.R
@@ -68,12 +68,10 @@
 #' @seealso
 #' [create_CRU_stack], [manage_cache].
 #'
-#' @return A \CRANpkg{data.table} object of \acronym{CRU} \acronym{CL} v. 2.0
-#'  climatology elements.
-#'
 #' @author Adam H. Sparks, \email{adamhsparks@@gmail.com}
 #' @inherit create_CRU_df source
 #' @inherit create_CRU_df references
+#' @inherit create_CRU_df return
 #'
 #' @export
 

diff --git a/R/get_CRU_stack.R b/R/get_CRU_stack.R
@@ -21,12 +21,10 @@
 #' @seealso
 #' [create_CRU_stack], [manage_cache].
 #'
-#' @return A [base::list] of [terra::rast] objects of CRU CL v. 2.0 climatology
-#'  elements.
-#'
 #' @author Adam H. Sparks, \email{adamhsparks@@gmail.com}
 #' @inherit create_CRU_df source
 #' @inherit create_CRU_df references
+#' @inherit create_CRU_stack return
 #'
 #' @export
 

diff --git a/codemeta.json b/codemeta.json
@@ -254,7 +254,7 @@
   "applicationCategory": "Tools",
   "isPartOf": "https://ropensci.org",
   "keywords": ["anglia-cru", "climate-data", "cru-cl2", "temperature", "rainfall", "elevation", "data-access", "wind", "relative-humidity", "solar-radiation", "diurnal-temperature", "frost", "cru", "r", "rstats", "r-package", "peer-reviewed"],
-  "fileSize": "918.223KB",
+  "fileSize": "918.176KB",
   "citation": [
     {
       "@type": "ScholarlyArticle",

diff --git a/man/create_CRU_df.Rd b/man/create_CRU_df.Rd
diff --git a/man/get_CRU_df.Rd b/man/get_CRU_df.Rd
diff --git a/man/get_CRU_stack.Rd b/man/get_CRU_stack.Rd