From eec6c742fd5d9cc7c1671e858a815f8eac0e42f8 Mon Sep 17 00:00:00 2001 From: "Adam H. Sparks" Date: Tue, 17 Dec 2024 18:48:24 +0800 Subject: [PATCH] Use more inherited Roxygen tags --- R/create_CRU_df.R | 4 ++-- R/get_CRU_df.R | 4 +--- R/get_CRU_stack.R | 4 +--- codemeta.json | 2 +- man/create_CRU_df.Rd | 4 ++-- man/get_CRU_df.Rd | 4 ++-- man/get_CRU_stack.Rd | 4 ++-- 7 files changed, 11 insertions(+), 15 deletions(-) diff --git a/R/create_CRU_df.R b/R/create_CRU_df.R index ae0ead8..dd0053c 100644 --- 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 index 1504ba8..bbc1245 100644 --- 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 index 507d1e0..1d5491e 100644 --- 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 index dccb649..a916272 100644 --- 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 index 7edfdce..6801202 100644 --- a/man/create_CRU_df.Rd +++ b/man/create_CRU_df.Rd @@ -96,8 +96,8 @@ the data frame, \code{TRUE}. Defaults to \code{FALSE}.} files are located.} } \value{ -A \CRANpkg{data.table} object of \acronym{CRU} \acronym{CL} v. 2.0 -climatology elements. +A \link[data.table:data.table]{data.table::data.table} object of \acronym{CRU} \acronym{CL} v. +2.0 climatology elements. } \description{ Automates importing \acronym{CRU} \acronym{CL} v.2.0 climatology diff --git a/man/get_CRU_df.Rd b/man/get_CRU_df.Rd index 0f15410..a4b3e7d 100644 --- a/man/get_CRU_df.Rd +++ b/man/get_CRU_df.Rd @@ -97,8 +97,8 @@ To take advantage of cached files in future sessions, use \code{cache = TRUE} even after the initial download and caching. Defaults to \code{FALSE}.} } \value{ -A \CRANpkg{data.table} object of \acronym{CRU} \acronym{CL} v. 2.0 -climatology elements. +A \link[data.table:data.table]{data.table::data.table} object of \acronym{CRU} \acronym{CL} v. +2.0 climatology elements. } \description{ This function automates downloading and importing \acronym{CRU} diff --git a/man/get_CRU_stack.Rd b/man/get_CRU_stack.Rd index 59cec81..f163261 100644 --- a/man/get_CRU_stack.Rd +++ b/man/get_CRU_stack.Rd @@ -97,8 +97,8 @@ To take advantage of cached files in future sessions, use \code{cache = TRUE} even after the initial download and caching. Defaults to \code{FALSE}.} } \value{ -A \link[base:list]{base::list} of \link[terra:rast]{terra::rast} objects of CRU CL v. 2.0 climatology -elements. +A \link[base:list]{base::list} of \link[terra:rast]{terra::rast} objects of \acronym{CRU} \acronym{CL} +v. 2.0 climatology elements. } \description{ This function automates downloading and importing CRU CL v. 2.0