adding support for multiple taxnomy download

Author: jhnwllr

DESCRIPTION

@@ -8,7 +8,7 @@ Description: A programmatic interface to the Web Service methods
     retrieving information on data providers, getting species occurrence
     records, getting counts of occurrence records, and using the GBIF
     tile map service to make rasters summarizing huge amounts of data.
-Version: 3.8.4.4
+Version: 3.8.4.5
 License: MIT + file LICENSE
 Authors@R: c(
     person("Scott", "Chamberlain", role = "aut", comment = c("0000-0003-1444-9135")),

R/download_predicate_dsl.R

@@ -3,6 +3,9 @@
 #' @name download_predicate_dsl
 #' @param key (character) the key for the predicate. See "Keys" below
 #' @param value (various) the value for the predicate
+#' @param checklistKey (character) A checklistKey to use for downloading using 
+#' alternative taxonomies. The default is `NULL`, which means the GBIF backbone
+#' taxonomy will be used.
 #' @param ...,.list For `pred_or()` or `pred_and()`, one or more objects of
 #' class `occ_predicate`, created by any `pred*` function
 #' @section predicate methods and their equivalent types:
@@ -224,7 +227,7 @@
 
 #' @rdname download_predicate_dsl
 #' @export
-pred <- function(key, value) pred_factory("=")(key, value)
+pred <- function(key, value, checklistKey = NULL) pred_factory("=")(key, value, checklistKey)
 #' @rdname download_predicate_dsl
 #' @export
 pred_gt <- function(key, value) pred_factory(">")(key, value)
@@ -302,10 +305,18 @@ print.occ_predicate_list <- function(x, ...) {
 
 # helpers
 pred_factory <- function(type) {
-  function(key, value) {
+  function(key, value, checklistKey = NULL) {
     if (!length(key) == 1) stop("'key' must be length 1", call. = FALSE)
     if (!length(value) == 1) stop("'value' must be length 1", call. = FALSE)
-    z <- parse_pred(key, value, type)
+    if (!is.null(checklistKey)) {
+      if (key != "taxonKey") {
+        stop("`checklistKey` can only be used when `key` is 'taxonKey'", call. = FALSE)
+      }
+      if (!is_uuid(checklistKey)) {
+        stop("`checklistKey` must be a valid UUID", call. = FALSE)
+      }
+    }
+    z <- parse_pred(key, value, type, checklistKey)
     structure(z, class = "occ_predicate")
   }
 }
@@ -513,9 +524,10 @@ key_lkup <- list(
   INSTITUTION_KEY = "INSTITUTION_KEY"
   )
 
-parse_pred <- function(key, value, type = "and") {
+parse_pred <- function(key, value, type = "and", checklistKey = NULL) {
   assert(key, "character")
   assert(type, "character")
+  assert(checklistKey, "character")
 
   ogkey <- key
   key <- key_lkup[[key]]
@@ -544,6 +556,13 @@ parse_pred <- function(key, value, type = "and") {
     list(type = unbox(type), parameter = unbox(key))
   } else if (type == "isNull") {
     list(type = unbox(type), parameter = unbox(key))
+  } else if (type == "equals" & !is.null(checklistKey) & key == "TAXON_KEY") {
+    list(
+      type = unbox(type),
+      key = unbox(key),
+      value = unbox(as_c(value)),
+      checklistKey = unbox(checklistKey)
+    )
   } else {
     list(type = unbox(type), key = unbox(key), value = unbox(as_c(value)))
   }