simplify Roxygen reuse source and references

ropensci · Dec 17, 2024 · 17cb70d · 17cb70d
1 parent 2ab33a8
commit 17cb70d
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 56 deletions.
diff --git a/R/create_CRU_stack.R b/R/create_CRU_stack.R
@@ -32,24 +32,8 @@
 #'
 #' @author Adam H. Sparks, \email{adamhsparks@@gmail.com}
 #'
-#' @source
-#' \describe{
-#'  \item{pre}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_pre.dat.gz>}
-#'  \item{rd0}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_rd0.dat.gz>}
-#'  \item{tmp}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_tmp.dat.gz>}
-#'  \item{dtr}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_dtr.dat.gz>}
-#'  \item{reh}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_reh.dat.gz>}
-#'  \item{sunp}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_sunp.dat.gz>}
-#'  \item{frs}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_frs.dat.gz>}
-#'  \item{wnd}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_wnd.dat.gz>, areas originally including Antarctica are removed.}
-#'  \item{elv}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_elv.dat.gz>, values are converted from kilometres to metres.}
-#' }
-#' This package crops all spatial outputs to an extent of ymin = -60, ymax = 85,
-#' xmin = -180, xmax = 180.
-#'
-#' @references New, Mark, et al. "A high-resolution data set of surface climate
-#'  over global land areas." Climate research 21.1 (2002): 1-25.
-#'  <https://crudata.uea.ac.uk/cru/data/hrg/tmc/new_et_al_10minute_climate_CR.pdf>
+#' @inherit create_CRU_df source
+#' @inherit create_CRU_df references
 #'
 #' @export
 

diff --git a/R/get_CRU_df.R b/R/get_CRU_df.R
@@ -72,24 +72,8 @@
 #'  climatology elements.
 #'
 #' @author Adam H. Sparks, \email{adamhsparks@@gmail.com}
-#' @source
-#' \describe{
-#'  \item{pre}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_pre.dat.gz>}
-#'  \item{rd0}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_rd0.dat.gz>}
-#'  \item{tmp}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_tmp.dat.gz>}
-#'  \item{dtr}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_dtr.dat.gz>}
-#'  \item{reh}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_reh.dat.gz>}
-#'  \item{sunp}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_sunp.dat.gz>}
-#'  \item{frs}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_frs.dat.gz>}
-#'  \item{wnd}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_wnd.dat.gz>, areas originally including Antarctica are removed.}
-#'  \item{elv}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_elv.dat.gz>, values are converted from kilometres to metres.}
-#' }
-#' This package crops all spatial outputs to an extent of ymin = -60, ymax = 85,
-#' xmin = -180, xmax = 180.
-#'
-#' @references New, Mark, et al. "A high-resolution data set of surface climate
-#'  over global land areas." Climate research 21.1 (2002): 1-25.
-#'  <https://crudata.uea.ac.uk/cru/data/hrg/tmc/new_et_al_10minute_climate_CR.pdf>
+#' @inherit create_CRU_df source
+#' @inherit create_CRU_df references
 #'
 #' @export
 

diff --git a/R/get_CRU_stack.R b/R/get_CRU_stack.R
@@ -25,25 +25,8 @@
 #'  elements.
 #'
 #' @author Adam H. Sparks, \email{adamhsparks@@gmail.com}
-#'
-#' @source
-#' \describe{
-#'  \item{pre}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_pre.dat.gz>}
-#'  \item{rd0}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_rd0.dat.gz>}
-#'  \item{tmp}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_tmp.dat.gz>}
-#'  \item{dtr}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_dtr.dat.gz>}
-#'  \item{reh}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_reh.dat.gz>}
-#'  \item{sunp}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_sunp.dat.gz>}
-#'  \item{frs}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_frs.dat.gz>}
-#'  \item{wnd}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_wnd.dat.gz>, areas originally including Antarctica are removed.}
-#'  \item{elv}{<https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_elv.dat.gz>, values are converted from kilometres to metres.}
-#' }
-#' This package crops all spatial outputs to an extent of ymin = -60, ymax = 85,
-#' xmin = -180, xmax = 180.
-#'
-#' @references New, Mark, et al. "A high-resolution data set of surface climate
-#'  over global land areas." Climate research 21.1 (2002): 1-25.
-#'  <https://crudata.uea.ac.uk/cru/data/hrg/tmc/new_et_al_10minute_climate_CR.pdf>
+#' @inherit create_CRU_df source
+#' @inherit create_CRU_df references
 #'
 #' @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": "921.658KB",
+  "fileSize": "918.205KB",
   "citation": [
     {
       "@type": "ScholarlyArticle",