fix spelling error and a few other bugs, updates tests (#99)

* fix spelling error

* allow users to provide a service in case other than just uppper

* update documentation

* update vcr fixtures for tests

* update roxygen note

* update codemeta.json

* make get_key() more reable for programmers and error messages for end users

* update codemeta.json

* fix documentation

patched point item for rain description was incorrect

line breaks in find_forecast_towns

* update documentation with corrections and line breaks

Author: adamhsparks

DESCRIPTION

@@ -114,7 +114,7 @@ Language: en-US
 LazyData: true
 Roxygen: list(markdown = TRUE, roclets = c("collate", "namespace", "rd",
     "roxyglobals::global_roclet"))
-RoxygenNote: 7.3.2
+RoxygenNote: 7.3.3
 X-schema.org-applicationCategory: Tools
 X-schema.org-isPartOf: https://ropensci.org
 X-schema.org-keywords: dpird, bom, meteorological-data, weather-forecast,

R/find_forecast_towns.R

@@ -1,4 +1,3 @@
-
 #' Find the Nearest Town With a BOM Forecast
 #'
 #' For a given `latitude` and `longitude`, find the nearest town that the
@@ -16,8 +15,8 @@
 #' # find forecast towns near Esperance, WA
 #' find_forecast_towns(longitude = 121.8913, latitude = -33.8614)
 #'
-#' @return A [data.table::data.table()] of all forecast towns (in this package) sorted by
-#'   distance from \var{latitude} and \var{longitude}, ascending.
+#' @return A [data.table::data.table()] of all forecast towns (in this package)
+#'   sorted by distance from \var{latitude} and \var{longitude}, ascending.
 #' @author Hugh Parsonage, \email{hugh.parsonage@@gmail.com}, and James Goldie,
 #'   \email{me@@jamesgoldie.dev}, and Adam H. Sparks,
 #'   \email{adamhsparks@@gmail.com}
@@ -28,9 +27,7 @@
 #' @export
 
 find_forecast_towns <-
-  function(longitude = 149.2,
-           latitude = -35.3,
-           distance_km = 100) {
+  function(longitude = 149.2, latitude = -35.3, distance_km = 100) {
     lonlat <- .check_lonlat(longitude = longitude, latitude = latitude)
 
     user_longitude <- lonlat["longitude"]
@@ -51,30 +48,41 @@ find_forecast_towns <-
 
     forecast_towns <-
       data.table::data.table(foreign::read.dbf(file_dbf, as.is = TRUE))
-    data.table::setnames(forecast_towns, names(forecast_towns),
-                         tolower(names(forecast_towns)))
+    data.table::setnames(
+      forecast_towns,
+      names(forecast_towns),
+      tolower(names(forecast_towns))
+    )
     data.table::setcolorder(forecast_towns, c(2:3, 7:9))
-    data.table::setnames(forecast_towns,
-                         old = c("pt_name", "lat", "lon", "elevation"),
-                         new = c("town", "latitude", "longitude", "elev_m"))
-    forecast_towns <- forecast_towns[, c("aac",
-                                         "town",
-                                         "longitude",
-                                         "latitude",
-                                         "elev_m")]
+    data.table::setnames(
+      forecast_towns,
+      old = c("pt_name", "lat", "lon", "elevation"),
+      new = c("town", "latitude", "longitude", "elev_m")
+    )
+    forecast_towns <- forecast_towns[, c(
+      "aac",
+      "town",
+      "longitude",
+      "latitude",
+      "elev_m"
+    )]
     data.table::setkey(forecast_towns, "aac")
 
-    forecast_towns[, "distance" := .haversine_distance(
-      lat1 = latitude,
-      lon1 = longitude,
-      lat2 = user_latitude,
-      lon2 = user_longitude
-    )] |>
+    forecast_towns[,
+      "distance" := .haversine_distance(
+        lat1 = latitude,
+        lon1 = longitude,
+        lat2 = user_latitude,
+        lon2 = user_longitude
+      )
+    ] |>
       data.table::setorderv("distance")
 
     forecast_towns[, distance := round(distance, 1)]
-    out <- forecast_towns[distance %in%
-                     forecast_towns[(distance <= distance_km)]$distance]
+    out <- forecast_towns[
+      distance %in%
+        forecast_towns[(distance <= distance_km)]$distance
+    ]
     data.table::setkey(out, "aac")
     return(out[])
   }

R/get_key.R

@@ -26,64 +26,66 @@
 #'
 #' @export
 get_key <- function(service = c("DPIRD", "SILO")) {
+  service <- toupper(service)
 
   service <- match.arg(service)
 
   if (service == "DPIRD") {
     DPIRD_API_KEY <- Sys.getenv("DPIRD_API_KEY")
-
-    if (!nzchar(DPIRD_API_KEY)) {
-      .set_dpird_key()
-    } else {
+    if (nzchar(DPIRD_API_KEY)) {
       return(DPIRD_API_KEY)
     }
+    return(.set_dpird_key())
   } else {
     SILO_API_KEY <- Sys.getenv("SILO_API_KEY")
-    if (!nzchar(SILO_API_KEY)) {
-      .set_silo_key()
-    } else {
+    if (nzchar(SILO_API_KEY)) {
       return(SILO_API_KEY)
     }
+    return(.set_silo_key())
   }
 }
 
-  #' Help the User Request an API Key for the DPIRD API
-  #'
-  #' Opens a browser window at the DPIRD API key request URL and provides
-  #'   instruction on how to store the key. After filling the form you will get
-  #'   the key soon, but not immediately.
-  #'
-  #' @keywords internal
-  #' @noRd
-  #' @return Called for its side-effects, opens a browser window at the DPIRD
-  #'   weather data API key request form.
-  .set_dpird_key <- function() {
-    if (interactive()) {
-      utils::browseURL("https://www.dpird.wa.gov.au/forms/dpird-api-registration/")
-    }
-
-    stop(
-        "You need to set your DPIRD API key.\n",
-        "After getting your key set it as 'DPIRD_API_KEY' in .Renviron.\n",
-        "DPIRD_API_KEY='youractualkeynotthisstring'\n",
-        "For that, use `usethis::edit_r_environ()`"
+#' Help the User Request an API Key for the DPIRD API
+#'
+#' Opens a browser window at the DPIRD API key request URL and provides
+#'   instruction on how to store the key. After filling the form you will get
+#'   the key soon, but not immediately.
+#'
+#' @keywords internal
+#' @noRd
+#' @return Called for its side-effects, opens a browser window at the DPIRD
+#'   weather data API key request form.
+.set_dpird_key <- function() {
+  if (interactive()) {
+    utils::browseURL(
+      "https://www.dpird.wa.gov.au/forms/dpird-api-registration/"
     )
   }
 
-  #' Help the User Set Up Their SILO API Key
-  #'
-  #' Instructs the user on how to set up the SILO API key to automatically find
-  #'   it.
-  #'
-  #' @return Invisible `NULL`, called for its side-effects, returns a message
-  #'   with instructions.
-  #' @keywords internal
-  #' @noRd
+  stop(
+    "You need to set your DPIRD API key.\n",
+    "After getting your key set it as 'DPIRD_API_KEY' in .Renviron.\n",
+    "DPIRD_API_KEY='youractualkeynotthisstring'\n",
+    "For that, use `usethis::edit_r_environ()`",
+    call. = FALSE
+  )
+}
+
+#' Help the User Set Up Their SILO API Key
+#'
+#' Instructs the user on how to set up the SILO API key to automatically find
+#'   it.
+#'
+#' @return Invisible `NULL`, called for its side-effects, returns a message
+#'   with instructions.
+#' @keywords internal
+#' @noRd
 
-  .set_silo_key <- function() {
-    stop(
-        "Set your SILO API key (email address) as 'SILO_API_KEY' in .Renviron.\n",
-        "SILO_API_KEY='youractualemailnotthisstring'\n",
-        "For that, use `usethis::edit_r_environ()`"
-    )
-  }
+.set_silo_key <- function() {
+  stop(
+    "Set your SILO API key (email address) as 'SILO_API_KEY' in .Renviron.\n",
+    "SILO_API_KEY='youractualemailnotthisstring'\n",
+    "For that, use `usethis::edit_r_environ()`",
+    call. = FALSE
+  )
+}

R/get_patched_point.R

@@ -1,4 +1,3 @@
-
 #' Get PatchedPoint Weather Data From SILO
 #'
 #' Fetch nicely formatted weather data from the \acronym{SILO} \acronym{API}
@@ -50,7 +49,7 @@
 #'
 #' \describe{
 #'  \item{all}{Which will return all of the following values}
-#'  \item{rain (mm)}{Rainfall}
+#'  \item{rain}{Rainfall}
 #'  \item{max_temp (degrees C)}{Maximum temperature}
 #'  \item{min_temp (degrees C)}{Minimum temperature}
 #'  \item{vp (hPa)}{Vapour pressure}
@@ -169,26 +168,26 @@
 #' @autoglobal
 #' @export
 
-get_patched_point <- function(station_code,
-                              start_date,
-                              end_date = Sys.Date(),
-                              values = "all",
-                              api_key = get_key(service = "SILO")) {
-
+get_patched_point <- function(
+  station_code,
+  start_date,
+  end_date = Sys.Date(),
+  values = "all",
+  api_key = get_key(service = "SILO")
+) {
   # simplify using the metadata to fetch weather data by converting factors to
   # numeric values
   if (inherits(x = station_code, what = "factor")) {
     station_code <- as.character(station_code)
   }
 
   if (missing(station_code) | !is.character(station_code)) {
-    stop(call. = FALSE,
-         "Please supply a valid `station_code`.")
+    stop(call. = FALSE, "Please supply a valid `station_code`.")
   }
 
-  if (missing(start_date))
-    stop(call. = FALSE,
-         "Please supply a valid start date as `start_date`.")
+  if (missing(start_date)) {
+    stop(call. = FALSE, "Please supply a valid start date as `start_date`.")
+  }
 
   .check_not_example_api_key(api_key)
   .is_valid_email_silo_api_key(api_key)
@@ -217,13 +216,10 @@ get_patched_point <- function(station_code,
   )
 
   data.table::setcolorder(out, order(names(out)))
-  data.table::setcolorder(out,
-                          c("station_code",
-                            "station_name",
-                            "year",
-                            "month",
-                            "day",
-                            "date"))
+  data.table::setcolorder(
+    out,
+    c("station_code", "station_name", "year", "month", "day", "date")
+  )
 
   out[]
 }

codemeta.json

@@ -2,7 +2,7 @@
   "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
   "@type": "SoftwareSourceCode",
   "identifier": "weatherOz",
-  "description": "Provides automated downloading, parsing and formatting of weather data for Australia through API endpoints provided by the Department of Primary Industries and Regional Development ('DPIRD') of Western Australia and by the Science and Technology Division of the Queensland Government's Department of Environment and Science ('DES'). As well as the Bureau of Meteorology ('BOM') of the Australian government precis and coastal forecasts, and downloading and importing radar and satellite imagery files. 'DPIRD' weather data are accessed through public 'APIs' provided by 'DPIRD', <https://www.dpird.wa.gov.au/online-tools/apis/>, providing access to weather station data from the 'DPIRD' weather station network. Australia-wide weather data are based on data from the Australian Bureau of Meteorology ('BOM') data and accessed through 'SILO' (Scientific Information for Land Owners) Jeffrey et al. (2001) <doi:10.1016/S1364-8152(01)00008-1>. 'DPIRD' data are made available under a Creative Commons Attribution 3.0 Licence (CC BY 3.0 AU) license <https://creativecommons.org/licenses/by/3.0/au/deed.en>. SILO data are released under a Creative Commons Attribution 4.0 International licence (CC BY 4.0) <https://creativecommons.org/licenses/by/4.0/>. 'BOM' data are (c) Australian Government Bureau of Meteorology and released under a Creative Commons (CC) Attribution 3.0 licence or Public Access Licence ('PAL') as appropriate, see <http://www.bom.gov.au/other/copyright.shtml> for further details.",
+  "description": "Provides automated downloading, parsing and formatting of weather data for Australia through API endpoints provided by the Department of Primary Industries and Regional Development (DPIRD) of Western Australia and by the Science and Technology Division of the Queensland Government's Department of Environment and Science (DES). As well as the Bureau of Meteorology (BOM) of the Australian government precis and coastal forecasts, and downloading and importing radar and satellite imagery files. DPIRD weather data are accessed through public APIs provided by DPIRD, <https://www.dpird.wa.gov.au/online-tools/apis/>, providing access to weather station data from the DPIRD weather station network. Australia-wide weather data are based on data from the Australian Bureau of Meteorology (BOM) data and accessed through SILO (Scientific Information for Land Owners) Jeffrey et al. (2001) <doi:10.1016/S1364-8152(01)00008-1>. DPIRD data are made available under a Creative Commons Attribution 3.0 Licence (CC BY 3.0 AU) license <https://creativecommons.org/licenses/by/3.0/au/deed.en>. SILO data are released under a Creative Commons Attribution 4.0 International licence (CC BY 4.0) <https://creativecommons.org/licenses/by/4.0/>. BOM data are (c) Australian Government Bureau of Meteorology and released under a Creative Commons (CC) Attribution 3.0 licence or Public Access Licence (PAL) as appropriate, see <http://www.bom.gov.au/other/copyright.shtml> for further details.",
   "name": "weatherOz: An API Client for Australian Weather and Climate Data Resources",
   "relatedLink": ["https://docs.ropensci.org/weatherOz/", "https://CRAN.R-project.org/package=weatherOz"],
   "codeRepository": "https://github.com/ropensci/weatherOz/",
@@ -14,7 +14,7 @@
     "name": "R",
     "url": "https://r-project.org"
   },
-  "runtimePlatform": "R version 4.4.3 (2025-02-28)",
+  "runtimePlatform": "R version 4.5.2 (2025-10-31)",
   "provider": {
     "@id": "https://cran.r-project.org",
     "@type": "Organization",
@@ -313,7 +313,7 @@
       "@type": "SoftwareApplication",
       "identifier": "vcr",
       "name": "vcr",
-      "version": ">= 0.6.0",
+      "version": ">= 2.0.0",
       "provider": {
         "@id": "https://cran.r-project.org",
         "@type": "Organization",
@@ -392,27 +392,28 @@
     },
     "5": {
       "@type": "SoftwareApplication",
-      "identifier": "crul",
-      "name": "crul",
+      "identifier": "curl",
+      "name": "curl",
       "provider": {
         "@id": "https://cran.r-project.org",
         "@type": "Organization",
         "name": "Comprehensive R Archive Network (CRAN)",
         "url": "https://cran.r-project.org"
       },
-      "sameAs": "https://CRAN.R-project.org/package=crul"
+      "sameAs": "https://CRAN.R-project.org/package=curl"
     },
     "6": {
       "@type": "SoftwareApplication",
-      "identifier": "curl",
-      "name": "curl",
+      "identifier": "crul",
+      "name": "crul",
+      "version": ">= 1.6.0",
       "provider": {
         "@id": "https://cran.r-project.org",
         "@type": "Organization",
         "name": "Comprehensive R Archive Network (CRAN)",
         "url": "https://cran.r-project.org"
       },
-      "sameAs": "https://CRAN.R-project.org/package=curl"
+      "sameAs": "https://CRAN.R-project.org/package=crul"
     },
     "7": {
       "@type": "SoftwareApplication",
@@ -560,7 +561,7 @@
   "applicationCategory": "Tools",
   "isPartOf": "https://ropensci.org",
   "keywords": ["dpird", "bom", "meteorological-data", "weather-forecast", "australia", "weather", "weather-data", "meteorology", "western-australia", "australia-bureau-of-meteorology", "western-australia-agriculture", "australia-agriculture", "australia-climate", "australia-weather", "rstats", "climate", "api-client", "data", "weather-api", "rainfall", "r"],
-  "fileSize": "5505.495KB",
+  "fileSize": "5520.013KB",
   "citation": [
     {
       "@type": "ScholarlyArticle",
@@ -691,12 +692,12 @@
       "name": "{weatherOz}: An API Client for Australian Weather and Climate Data Resources in R",
       "identifier": "10.5281/zenodo.8191283",
       "url": "https://docs.ropensci.org/weatherOz/",
-      "description": "R package version 2.0.0",
+      "description": "R package version 2.0.2",
       "@id": "https://doi.org/10.5281/zenodo.8191283",
       "sameAs": "https://doi.org/10.5281/zenodo.8191283"
     }
   ],
-  "releaseNotes": "https://github.com/ropensci/weatherOz/blob/master/NEWS.md",
+  "releaseNotes": "https://github.com/ropensci/weatherOz/blob/main/NEWS.md",
   "readme": "https://github.com/ropensci/weatherOz/blob/main/README.md",
   "contIntegration": ["https://github.com/ropensci/weatherOz/actions/workflows/R-CMD-check.yaml", "https://app.codecov.io/gh/ropensci/weatherOz"],
   "developmentStatus": "https://lifecycle.r-lib.org/articles/stages.html#stable",