A function to retrieve Github Releases of taxonomic resources

.Rbuildignore

@@ -18,3 +18,6 @@
 ^CRAN-SUBMISSION$
 ^revdep
 ^.DS_Store
+^inst/cheatsheet$
+^help
+

NAMESPACE

@@ -5,6 +5,7 @@ export(create_species_state_origin_matrix)
 export(create_taxonomic_update_lookup)
 export(default_version)
 export(get_apc_genus_family_lookup)
+export(get_versions)
 export(load_taxonomic_resources)
 export(native_anywhere_in_australia)
 export(standardise_names)

R/APCalign-package.R

@@ -99,7 +99,8 @@ utils::globalVariables(
     "accepted_name_2",
     "alternative_accepted_name_tmp",
     "pro_parte",
-    "suggested_collapsed_name"
+    "suggested_collapsed_name",
+    "versions"
   )
 )
 

R/load_taxonomic_resources.R

@@ -27,7 +27,7 @@
 #' @examples
 #' \donttest{
 #' load_taxonomic_resources(stable_or_current_data="stable", 
-#' version="0.0.2.9000")}
+#' version="2024-10-11")}
 #'
 
 load_taxonomic_resources <-
@@ -302,7 +302,7 @@ load_taxonomic_resources <-
 ##'
 ##'
 ##' # Load the a stable version of the dataset
-##' dataset_access_function(version="0.0.2.9000",type = "stable")
+##' dataset_access_function(version="2024-10-11",type = "stable")
 ##'
 ##' @noRd
 dataset_access_function <-
@@ -487,3 +487,45 @@ dataset_get <- function(version = default_version(),
 
   }
 }
+
+
+#' Which versions of taxonomic resources are available?
+#'
+#' @return tibble of dates when APC/APNI resources were downloaded as a Github Release
+#' @export
+#'
+#' @examples
+#' get_versions()
+get_versions <- function() {
+  # Check if there is internet connection
+  ## Dummy variable to allow testing of network
+  network <- as.logical(Sys.getenv("NETWORK_UP", unset = TRUE)) 
+
+  if (!curl::has_internet() | !network) { # Simulate if network is down
+    message("No internet connection, please retry with stable connection (default_version)")
+    return(invisible(NULL))
+  } else {
+
+    # Get all the releases
+    url <-
+      paste0(
+        "https://api.github.com/repos/",
+        "traitecoevo",
+        "/",
+        "APCalign",
+        "/releases"
+      )
+
+    response <- httr::GET(url)
+
+    if(httr::http_error(response) | !network){
+      message("API currently down, try again later")
+      return(invisible(NULL))
+    } else
+      release_data <- httr::content(response, "text") |> jsonlite::fromJSON()
+
+    # Create table
+    dplyr::tibble(versions = unique(release_data$tag_name) |> sort(decreasing = TRUE)) |> 
+      dplyr::filter(!versions == "2020-05-14")
+  }
+}

_pkgdown.yml

@@ -45,5 +45,6 @@ reference:
 - subtitle: Data
 - contents:
   - load_taxonomic_resources
+  - get_versions
   - default_version
   - gbif_lite

tests/testthat/helper.R

@@ -2,5 +2,5 @@
 if(exists("resources", envir = globalenv())) {
   resources <- get("resources", envir = globalenv())
 } else {
-  resources <- load_taxonomic_resources(stable_or_current_data = "stable", version = "0.0.2.9000")
+  resources <- load_taxonomic_resources(stable_or_current_data = "stable", version = "2024-10-11")
 }

tests/testthat/test-connection.R

@@ -1,16 +1,16 @@
 test_that("Complains when network is down", {
-  skip_if_offline(host = "api.github.com")
+  skip_on_ci()
 
   Sys.setenv("NETWORK_UP" = FALSE)
   expect_message(default_version())
   expect_message(dataset_access_function())
   expect_message(dataset_get())
 
   #commenting out for now to test in CI, see issue #235
-  #Sys.setenv("NETWORK_UP" = TRUE)
-  #expect_visible(default_version())
-  #expect_visible(dataset_access_function())
-  #expect_visible(dataset_get())
+  Sys.setenv("NETWORK_UP" = TRUE)
+  expect_visible(default_version())
+  expect_visible(dataset_access_function())
+  expect_visible(dataset_get())
 })
 
 

tests/testthat/test-versions.R

@@ -0,0 +1,10 @@
+test_that("Retrieval is possible", {
+  skip_on_ci()
+
+  Sys.setenv("NETWORK_UP" = TRUE)
+  versions <- get_versions()
+
+  expect_visible(versions)
+  expect_named(versions)
+})
+