Add lon/lat as attributes of get_parameters() to solve #4

Author: NRaillard

NEWS.md

@@ -1,5 +1,7 @@
 # resourcecode (development version)
 
+- Add node coordinates as attributes of the output from `get_parameters()` to solve #4;
+
 # resourcecode 0.5.3
 
 - Custom labels are now handled properly in `cut_seasons()` ;

R/download_data.R

@@ -26,15 +26,15 @@ get_parameters_raw <- function(
   end_str <- strftime(end, format = "%Y-%m-%dT%H:%M:%SZ", tz = "UTC")
 
   # Cassandra database start indexing at 1, so decrements node number
-  node <- node - 1
+  node_cassandra <- node - 1
 
   request_url <- paste0(
     rcd_cassandra_url,
     "api/timeseries",
     "?parameter=",
     single_parameter,
     "&node=",
-    node,
+    node_cassandra,
     "&start=",
     start_str,
     "&end=",
@@ -117,6 +117,8 @@ get_parameters_raw <- function(
     tz = "UTC"
   ) # Convert UNIX time (ms) to POSIXct format
   attr(data, "node") <- node
+  attr(data, "longitude") <- resourcecodedata::rscd_field$longitude[node]
+  attr(data, "latitude") <- resourcecodedata::rscd_field$latitude[node]
   data
 }
 
@@ -143,26 +145,48 @@ get_parameters <- function(
   start = as.POSIXct("1994-01-01 00:00:00", tz = "UTC"),
   end = as.POSIXct("1994-12-31 23:00:00", tz = "UTC")
 ) {
-  parameters <- tolower(parameters)
+  valid_parameters <- tolower(parameters)
 
-  if (any(parameters %nin% c("tp", resourcecodedata::rscd_variables$name))) {
-    errors <- parameters[
-      parameters %nin% c("tp", resourcecodedata::rscd_variables$name)
+  if (any(c("lon", "longitude", "lat", "latitude") %in% valid_parameters)) {
+    valid_parameters = valid_parameters[
+      valid_parameters %nin% c("lon", "longitude", "lat", "latitude")
     ]
-    stop(
-      "Requested parameters do not exists in the database: ",
-      paste0(errors, collapse = ", "),
-      "."
+    warning(
+      "Coordinates are given as attributes of the resulting data.frame and should not be requested."
     )
   }
 
+  if (length(valid_parameters) == 0) {
+    rlang::abort("No valid parameters are provided. Exiting.")
+  }
+
+  if (
+    any(valid_parameters %nin% c("tp", resourcecodedata::rscd_variables$name))
+  ) {
+    errors <- valid_parameters[
+      valid_parameters %nin% c("tp", resourcecodedata::rscd_variables$name)
+    ]
+    valid_parameters = valid_parameters[
+      valid_parameters %in% c("tp", resourcecodedata::rscd_variables$name)
+    ]
+    if (length(valid_parameters) == 0) {
+      rlang::abort("No valid parameters are provided. Exiting.")
+    } else {
+      warning(
+        "Requested parameters do not exist in the database and are ignored: ",
+        paste0(errors, collapse = ", "),
+        "."
+      )
+    }
+  }
+
   node <- as.integer(node)
 
   if (length(node) != 1) {
-    stop("The function can retreive only one location a time.")
+    rlang::abort("The function can retreive only one location a time.")
   }
   if (node %nin% resourcecodedata::rscd_field$node) {
-    stop("The requested location do no exist in the database.")
+    rlang::abort("The requested location do no exist in the database.")
   }
 
   if (is.character(start)) {
@@ -216,33 +240,33 @@ get_parameters <- function(
   }
 
   out <- get_parameters_raw(
-    parameters[1],
+    valid_parameters[1],
     node = node,
     start = start,
     end = end
   )
 
   # If first parameter retrieval failed, return NULL
   if (is.null(out)) {
-    message("Failed to retrieve parameter: ", parameters[1])
+    message("Failed to retrieve parameter: ", valid_parameters[1])
     return(NULL)
   }
 
-  for (i in seq_len(length(parameters) - 1)) {
+  for (i in seq_len(length(valid_parameters) - 1)) {
     temp <- get_parameters_raw(
-      parameters[i + 1],
+      valid_parameters[i + 1],
       node = node,
       start = start,
       end = end
     )
 
     # If any subsequent parameter retrieval fails, return NULL
     if (is.null(temp)) {
-      message("Failed to retrieve parameter: ", parameters[i + 1])
+      message("Failed to retrieve parameter: ", valid_parameters[i + 1])
       return(NULL)
     }
 
-    out <- cbind.data.frame(out, temp[, 2])
+    out[valid_parameters[i + 1]] <- temp[2]
   }
   out
 }

R/spectral_data_download.R

@@ -243,12 +243,12 @@ get_1d_spectrum_raw <- function(point, year, month) {
 #' }
 #' @export
 #'
-#' @examples
+#' @examplesIf (identical(Sys.getenv("NOT_CRAN"), "true") || identical(Sys.getenv("IN_PKGDOWN"), "true"))
 #' spec2D <- get_2d_spectrum("SEMREVO", start = "1994-01-01", end = "1994-02-28")
 #' if(!is.null(spec2D)){
 #'   image(spec2D$dir, spec2D$freq, spec2D$efth[, , 1],
-#'     xlab = "Direction (°)",
-#'     ylab = "Frequency (Hz"
+#'     xlab = "Direction (\u00B0)",
+#'     ylab = "Frequency (Hz)"
 #'   )
 #' }
 get_2d_spectrum <- function(point, start = "1994-01-01", end = "1994-02-28") {
@@ -369,7 +369,7 @@ get_2d_spectrum <- function(point, start = "1994-01-01", end = "1994-02-28") {
 #' }
 #' @export
 #'
-#' @examples
+#' @examplesIf (identical(Sys.getenv("NOT_CRAN"), "true") || identical(Sys.getenv("IN_PKGDOWN"), "true"))
 #' spec1D <- get_1d_spectrum("SEMREVO", start = "1994-01-01", end = "1994-02-28")
 #' if(!is.null(spec1D)){
 #'   r <- as.POSIXct(round(range(spec1D$forcings$time), "month"))

README.md

@@ -83,10 +83,12 @@ Finistère:
 ``` r
 data <- get_parameters(node = "134865", parameters = "hs")
 str(data)
-#> tibble [8,760 × 2] (S3: tbl_df/tbl/data.frame)
+#> tibble [8,760 x 2] (S3: tbl_df/tbl/data.frame)
 #>  $ time: POSIXct[1:8760], format: "1994-01-01 00:00:00" "1994-01-01 01:00:00" ...
 #>  $ hs  : num [1:8760] 4.82 4.98 5.19 5.37 5.48 ...
-#>  - attr(*, "node")= num 134864
+#>  - attr(*, "node")= int 134865
+#>  - attr(*, "longitude")= num -4.96
+#>  - attr(*, "latitude")= num 48.3
 if (!is.null(data)) plot(data, type = "l")
 ```
 

man/figures/README-data_fetcher-1.png

@@ -71,12 +71,12 @@ test_that("get_parameters handles numeric date inputs", {
 
 # Error handling tests (these don't need vcr as they fail before API call)
 test_that("get_parameters validates parameter names", {
-  expect_error(
+  expect_warning(
     get_parameters(
       parameters = c("hs", "invalid_param"),
       node = 42
     ),
-    "Requested parameters do not exists"
+    "Requested parameters do not exist in the database"
   )
 })
 
@@ -268,49 +268,32 @@ test_that("get_parameters handles partial failure with multiple parameters", {
 
 
 test_that("Errors in 'get_parameters()' are handled correcly", {
+  expect_warning(
+    get_parameters(parameters = c("hs", "tépé")),
+    "Requested parameters do not exist in the database"
+  )
   expect_error(
     get_parameters("tépé"),
-    "Requested parameters do not exists in the database: tépé"
+    "No valid parameters are provided. Exiting."
   )
   expect_error(
     get_parameters(node = 0),
     "The requested location do no exist in the database."
   )
+  expect_error(
+    suppressWarnings(get_parameters(node = "un")),
+    "The requested location do no exist in the database."
+  )
   expect_error(
     get_parameters(node = c(10, 100)),
     "The function can retreive only one location a time."
   )
   expect_error(
     get_parameters(start = 1),
-    paste0(
-      "'start' is outside the covered period: ",
-      paste(
-        format(
-          c(
-            resourcecode:::rscd_casandra_start_date,
-            resourcecode:::rscd_casandra_end_date
-          ),
-          format = "%Y-%m-%d %H:%M %Z"
-        ),
-        collapse = " \u2014 "
-      )
-    )
+    "'start' is outside the covered period: "
   )
   expect_error(
-    get_parameters(end = 1e10),
-    paste0(
-      "'end' is outside the covered period: ",
-      paste(
-        format(
-          c(
-            resourcecode:::rscd_casandra_start_date,
-            resourcecode:::rscd_casandra_end_date
-          ),
-          format = "%Y-%m-%d %H:%M %Z"
-        ),
-        collapse = " \u2014 "
-      )
-    )
+    get_parameters(end = 1e12),
   )
   expect_error(
     get_parameters(