use {devtag} and fix @returns tag

Author: adamhsparks

.Rbuildignore

@@ -21,3 +21,12 @@
 
 # flint files
 ^flint$
+^man/dot-check_vars_FALSE\.Rd$
+^man/dot-validate_dsn\.Rd$
+^man/dot-create_df\.Rd$
+^man/dot-tidy_df\.Rd$
+^man/dot-read_cache\.Rd$
+^man/dot-create_stacks\.Rd$
+^man/dot-create_stack\.Rd$
+^man/dot-set_cache\.Rd$
+^man/dot-get_local\.Rd$

DESCRIPTION

@@ -56,11 +56,11 @@ Config/testthat/edition: 3
 Config/testthat/parallel: true
 Encoding: UTF-8
 Language: en-US
-Roxygen: list(markdown = TRUE, roclets = c("collate", "namespace", "rd",
-    "roxyglobals::global_roclet", "roxylint::roxylint"))
+Roxygen: list(markdown = TRUE, roclets = c("collate", "namespace", "rd", "roxyglobals::global_roclet", "roxylint::roxylint", "devtag::dev_roclet"))
 RoxygenNote: 7.3.2
 X-schema.org-applicationCategory: Tools
 X-schema.org-isPartOf: https://ropensci.org
 X-schema.org-keywords: anglia-cru, climate-data, cru-cl2, temperature,
     rainfall, elevation, data-access, wind, relative-humidity,
     solar-radiation, diurnal-temperature, frost
+Config/Needs/build: moodymudskipper/devtag

R/create_CRU_df.R

@@ -57,7 +57,7 @@
 #' @seealso
 #' [get_CRU_df].
 #'
-#' @return A [data.table::data.table] object of \acronym{CRU} \acronym{CL} v.
+#' @returns A [data.table::data.table] object of \acronym{CRU} \acronym{CL} v.
 #'  2.0 climatology elements.
 #'
 #' @author Adam H. Sparks, \email{adamhsparks@@gmail.com}

R/create_CRU_stack.R

@@ -6,9 +6,10 @@
 #' automatically calculated as described in the data
 #' [readme.txt](https://crudata.uea.ac.uk/cru/data/hrg/tmc/readme.txt) file.
 #' Data may be cached for later use by this function, saving time downloading
-#' files in future using this function.  This function can be useful if you have
-#' network connection issues that mean automated downloading of the files using
-#' \R does not work properly.
+#' files in future using this function.  This function can be useful if you
+#' have network connection issues that mean automated downloading of the files
+#' using \R does not work properly or you have cached the files locally for
+#' your own future use.
 #'
 #' @inheritSection get_CRU_df Nomenclature and Units
 #' @inheritParams create_CRU_df
@@ -31,8 +32,8 @@
 #' @seealso
 #' [get_CRU_stack].
 #'
-#' @return A [base::list] of [terra::rast] objects of \acronym{CRU} \acronym{CL}
-#'  v. 2.0 climatology elements.
+#' @returns A [base::list] of [terra::rast] objects of \acronym{CRU}
+#' \acronym{CL} v. 2.0 climatology elements.
 #'
 #' @export
 

R/internal_functions.R

@@ -42,8 +42,8 @@
 #'   wnd,
 #'   elv
 #' )
-#' @noRd
-#' @keywords Internal
+#' @dev
+
 
 .check_vars_FALSE <- function(pre,
                               pre_cv,
@@ -68,8 +68,8 @@
 #' Validates user entered dsn value
 #'
 #' @param dsn User provided value for checking.
-#' @keywords Internal
-#' @noRd
+
+#' @dev
 .validate_dsn <- function(dsn) {
   if (missing(dsn)) {
     cli::cli_abort(
@@ -106,10 +106,9 @@
 #' @param elv Is elv to be returned? Boolean.
 #' @param files File list to be used for creating data frame.
 #'
-#' @return A \CRANpkg{data.table} of all requested values.
-#' @keywords Internal
+#' @returns A \CRANpkg{data.table} of all requested values.
 #' @autoglobal
-#' @noRd
+#' @dev
 .create_df <-
   function(tmn, tmx, tmp, dtr, pre, pre_cv, elv, files) {
     CRU_df <-
@@ -141,8 +140,8 @@
   }
 
 #' Read Files from Disk Directory and Tidy Them
-#' @noRd
-#' @keywords Internal
+#' @dev
+
 .tidy_df <- function(pre_cv, elv, tmn, tmx, .files) {
   # create list of tidied data frames ----------------------------------------
   CRU_list <-
@@ -187,9 +186,8 @@
 #' @param .files a list of CRU CL2.0 files in local storage.
 #' @param .pre_cv `Boolean` return pre_cv in the data.
 #'
-#' @keywords Internal
 #' @autoglobal
-#' @noRd
+#' @dev
 
 .read_cache <- function(.files, .pre_cv) {
   month_names <-
@@ -282,9 +280,8 @@
 #'  `rast`, Boolean.
 #' @param files List. Files that are to be used in creating the `rast` object.
 #'
-#' @keywords Internal
 #' @autoglobal
-#' @noRd
+#' @dev
 #'
 .create_stacks <- function(tmn, tmx, tmp, dtr, pre, pre_cv, files) {
   wrld <-
@@ -360,8 +357,7 @@
 #' @param pre_cv `Boolean` include preciptation cv.
 #'
 #' @autoglobal
-#' @keywords Internal
-#' @noRd
+#' @dev
 .create_stack <- function(files,
                           wrld,
                           month_names,
@@ -437,8 +433,8 @@
 #'
 #' @param cache `Boolean` (create) and use local file cache.
 #'
-#' @keywords Internal
-#' @noRd
+
+#' @dev
 .set_cache <- function(cache) {
   manage_cache <- hoardr::hoard()
   manage_cache$cache_path_set(
@@ -483,8 +479,7 @@
 #' @param elv Boolean, loads elevation (converted to metres) and returns it in
 #' the data frame.
 #'
-#' @keywords Internal
-#' @noRd
+#' @dev
 .get_local <- function(pre,
                        pre_cv,
                        rd0,

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": "912.533KB",
+  "fileSize": "912.393KB",
   "citation": [
     {
       "@type": "ScholarlyArticle",