lint the Roxygen

DESCRIPTION

@@ -55,13 +55,16 @@ Suggests:
     vcr (>= 0.6.0)
 VignetteBuilder: 
     knitr
+Config/Needs/documentation: roxylint
+Config/roxylint: list(linters = roxylint::tidy)
 Config/testthat/edition: 3
 Config/testthat/parallel: true
 Encoding: UTF-8
 Language: en-US
 NeedsCompilation: no
 Repository: CRAN
-Roxygen: list(markdown = TRUE)
+Roxygen: list(markdown = TRUE, roclets = c("collate", "namespace", "rd",
+    "roxylint::roxylint"))
 RoxygenNote: 7.3.2
 X-schema.org-applicationCategory: Tools
 X-schema.org-isPartOf: https://ropensci.org

R/get_power.R

@@ -1,4 +1,4 @@
-#' Get NASA POWER Data From the POWER API
+#' Get NASA POWER data from the POWER API
 #'
 #' @description Get \acronym{POWER} global meteorology and surface solar energy
 #'   climatology data and return a tidy data frame [tibble::tibble()]
@@ -43,7 +43,7 @@
 #'    <https://power.larc.nasa.gov/docs/methodology/meteorology/wind/>.
 #' @param wind_surface A user-supplied wind surface for which the corrected
 #'   wind-speed is to be supplied.  See `wind-surface` section for more detail.
-#' @param time_standard \acronym{POWER} provides two different time standards:
+#' @param time_standard \acronym{POWER} provides two different time standards.
 #'    * Universal Time Coordinated (\acronym{UTC}): is the standard time measure
 #'     that used by the world.
 #'    * Local Solar Time (\acronym{LST}): A 15 degree swath that represents
@@ -145,7 +145,7 @@
 #'
 #' @return A data frame as a `POWER.Info` class, an extension of the
 #' [tibble::tibble], object of \acronym{POWER} data including location, dates
-#' (not including \dQuote{climatology}) and requested parameters.  A decorative
+#' (not including \dQuote{climatology}) and requested parameters; a decorative
 #' header of metadata is included in this object.
 #'
 #' @references
@@ -316,15 +316,15 @@ get_power <- function(community = c("ag", "re", "sb"),
 
 # subfunctions internal to get_power() -----------------------------------------
 
-#' Check Dates for Validity When Querying API
+#' Check dates for validity when querying the API
 #'
 #' Validates user entered dates against `lonlat` and `temporal_api` values
 #'
 #' @param dates User entered `dates` value.
 #' @param lonlat User entered `lonlat` value.
 #' @param temporal_api User entered `temporal_api` value.
 #'
-#' @return Validated dates in a list for use in `.build_query`
+#' @return Validated dates in a list for use in `.build_query`.
 #' @keywords internal
 #' @noRd
 .check_dates <- function(dates, lonlat, temporal_api) {
@@ -458,7 +458,7 @@ get_power <- function(community = c("ag", "re", "sb"),
 #'    <https://power.larc.nasa.gov/docs/methodology/meteorology/wind/>.
 #' @param wind_surface A user-supplied wind surface for which the corrected
 #'   wind-speed is to be supplied.  See `wind-surface` section for more detail.
-#' @return Nothing, called for its side-effects of checking user inputs
+#' @return Nothing, called for its side-effects of checking user inputs.
 #' @keywords Internal
 #' @noRd
 
@@ -573,7 +573,7 @@ get_power <- function(community = c("ag", "re", "sb"),
 #' @param lonlat User entered `lonlat` value.
 #' @param pars User entered `pars` value.
 #'
-#' @return A list called `lonlat_identifier` for use in [.build_query()]
+#' @return A list called `lonlat_identifier` for use in [.build_query()].
 #' @keywords internal
 #' @noRd
 .check_lonlat <-
@@ -678,14 +678,14 @@ get_power <- function(community = c("ag", "re", "sb"),
 #' Construct a list of options to pass to the POWER API
 #'
 #' @param community A validated value for community from [check_community()].
-#' @param lonlat_identifier A list of values, a result of [check_lonlat()]
+#' @param lonlat_identifier A list of values, a result of [check_lonlat()].
 #' @param pars A validated value from [check_pars()].
-#' @param dates A list of values, a result of [check_dates()].
-#' @param site_elevation A validated value from
-#' @param wind_elevation A validate value from
-#' @param wind_surface A validated value from
+#' @param dates A list of values, a result of [check_dates()]..
+#' @param site_elevation A validated value passed by `check_inputs`.
+#' @param wind_elevation A validated value passed by `check_inputs`.
+#' @param wind_surface A validated value passed by `check_inputs`.
 #' @return A `list` object of values to be passed to a [crul] object to query
-#'  the 'POWER' 'API'
+#'  the 'POWER' 'API'.
 #' @keywords internal
 #' @noRd
 .build_query <- function(community,

R/internal_functions.R

@@ -6,7 +6,7 @@
 #' @param table A table containing values to match `x` against.
 #'
 #' @return A logical vector, indicating if a mismatch was located for any
-#'  element of x: thus the values are TRUE or FALSE and never NA.
+#'  element of x: thus the values are `TRUE` or `FALSE` and never `NA`.
 #' @keywords internal
 #' @noRd
 `%notin%` <- function(x, table) {
@@ -21,7 +21,7 @@
 #' @param community User entered `community` value.
 #' @param temporal_api User entered `temporal_api` value.
 #'
-#' @return Validated a collapsed string of  `pars` for use in [.build_query()]
+#' @return Validated a collapsed string of  `pars` for use in [.build_query].
 #' @keywords internal
 #' @noRd
 .check_pars <-
@@ -75,8 +75,8 @@
 #' Boolean
 #'
 #' Checks if provided object is a Boolean i.e. a length-one logical vector.
-#' @param x an object to check
-#' @return a logical value indicating whether provided object is a Boolean
+#' @param x an object to check.
+#' @return a logical value indicating whether provided object is a `Boolean`.
 #' @examples
 #' is_boolean(TRUE) # [1] TRUE
 #' # the following will work on most systems, unless you have tweaked global Rprofile
@@ -123,13 +123,13 @@
   }
 }
 
-#' Sends the Query to the POWER Data API to Retrieve Data
+#' Sends the query to the POWER data API to retrieve data
 #'
 #' @param .query_list A query list created by [.build_query()]
 #' @param .url A character string of the URL to be used for the \acronym{API}
 #'  query
 #' @keywords internal
-#' @return A response from the POWER server containing either an error message
+#' @return A response from the POWER server containing either an error message.
 #'   or the data requested.
 #' @noRd
 #'
@@ -159,12 +159,12 @@
 }
 
 
-#' Sends the Query to the POWER Management API
+#' Sends the query to the POWER management API
 #'
 #' There are no parameters that these API end points accept.
 #'
 #' @param .url A character string of the URL to be used for the \acronym{API}
-#'  query
+#'  query.
 #' @keywords internal
 #' @return A response from the POWER server containing either an error message
 #'   or the data requested.

R/print_POWER_Info.R

@@ -1,7 +1,7 @@
-#' Prints Power.Info Object
+#' Prints Power.Info object
 #'
-#' @param x POWER.Info object
-#' @param ... ignored
+#' @param x POWER.Info object.
+#' @param ... ignored.
 #' @export
 #' @noRd
 print.POWER.Info <- function(x, ...) {

R/query_groupings.R

@@ -1,4 +1,4 @@
-#' Query the POWER API for Detailed Information on Available Parameter Groupings
+#' Query the POWER API for detailed information on available parameter groupings
 #'
 #' Queries the \acronym{POWER} \acronym{API} returning detailed information on
 #'  available parameter groupings grouped by community followed by temporal

R/query_parameters.R

@@ -1,4 +1,4 @@
-#' Query the POWER API for Detailed Information on Available Parameters
+#' Query the POWER API for detailed information on available parameters
 #'
 #' Queries the \acronym{POWER} \acronym{API} returning detailed information on
 #'  available parameters.  For a list of all available parameters, use

codemeta.json

@@ -251,7 +251,7 @@
   "applicationCategory": "Tools",
   "isPartOf": "https://ropensci.org",
   "keywords": ["NASA", "meteorological-data", "weather", "global", "weather-data", "meteorology", "NASA-POWER", "agroclimatology", "earth-science", "data-access", "climate-data", "r", "nasa-power", "nasa", "agroclimatology-data", "weather-variables", "rstats", "r-package"],
-  "fileSize": "511.742KB",
+  "fileSize": "511.981KB",
   "citation": [
     {
       "@type": "ScholarlyArticle",

nasapower.Rproj

@@ -1,4 +1,5 @@
 Version: 1.0
+ProjectId: b5850c27-668d-4a11-be2e-100f95063eb7
 
 RestoreWorkspace: No
 SaveWorkspace: No