BBOX fix

DESCRIPTION

@@ -54,4 +54,4 @@ VignetteBuilder:
 Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 6.1.1
+RoxygenNote: 7.0.0

NEWS.md

@@ -1,6 +1,7 @@
 # bcdata (development version)
 
 # bcdata 0.1.1.9999
+* Fixed a bug where `BBOX()` used in a `filter()` statement combined with `bcdc_query_geodata()` did not work (#135, #137)
 * Add `mutate` method for bcdc_promise that only fails and suggest an alternative approach. (PR#134)
 * Add back in querying vignette
 

R/cql-geom-predicates.R

@@ -24,9 +24,6 @@
 #' bcbdc_cql_string accepts the following geometric predicates: EQUALS,
 #' DISJOINT, INTERSECTS, TOUCHES, CROSSES,  WITHIN, CONTAINS, OVERLAPS, RELATE,
 #' DWITHIN, BEYOND, BBOX.
-#' @inheritParams RELATE
-#' @inheritParams BBOX
-#' @inheritParams DWITHIN
 #'
 #' @seealso sql_geom_predicates
 #'
@@ -51,13 +48,8 @@ bcdc_cql_string <- function(x, geometry_predicates, pattern = NULL,
          call. = FALSE)
   }
 
-
-  geom_col <- attr(x, "geom_col")
-  if(is.null(geom_col)) geom_col <- "GEOMETRY"
-
   match.arg(geometry_predicates, cql_geom_predicate_list())
 
-
   # Only convert x to bbox if not using BBOX CQL function
   # because it doesn't take a geom
   if (!geometry_predicates == "BBOX") {
@@ -97,8 +89,6 @@ sf_text <- function(x) {
          call. = FALSE)
   }
 
-
-
   ## If too big here, drawing bounding
   if(utils::object.size(x) > getOption("bcdata.max_geom_pred_size", 5E5)){
     warning("The object is too large to perform exact spatial operations using bcdata.
@@ -127,7 +117,7 @@ sf_text <- function(x) {
 #'
 #' @param geom an sf/sfc/sfg object
 #' @name cql_geom_predicates
-#' @return a CQL expression using the bounding box of the geom
+#' @return a CQL expression to be passed on to the WFS call
 NULL
 
 #' @rdname cql_geom_predicates
@@ -194,7 +184,9 @@ RELATE <- function(geom, pattern) {
 }
 
 #' @rdname cql_geom_predicates
-#' @param coords the coordinates of the bounding box.
+#' @param coords the coordinates of the bounding box as four-element numeric
+#'        vector `c(xmin, ymin, xmax, ymax)`, or a `bbox` object from the `sf`
+#'        package (the result of running `sf::st_bbox()` on an `sf` object).
 #' @param crs (Optional) A string containing an SRS code
 #' (For example, 'EPSG:1234'. The default is to use the CRS of the queried layer)
 #' @export
@@ -224,7 +216,6 @@ DWITHIN <- function(geom, distance,
 }
 
 #' @rdname cql_geom_predicates
-#' @inheritParams DWITHIN
 #' @export
 BEYOND <- function(geom, distance,
                    units = c("meters", "feet", "statute miles", "nautical miles", "kilometers")) {

R/cql-translator.R

@@ -57,19 +57,19 @@ cql_scalar <- dbplyr::sql_translator(
   `[` = `[`,
   `[[` = `[[`,
   `$` = `$`,
-  DWITHIN = function(x) DWITHIN(x),
-  EQUALS = function(x) EQUALS(x),
-  DISJOINT = function(x) DISJOINT(x),
-  INTERSECTS = function(x) INTERSECTS(x),
-  TOUCHES = function(x) TOUCHES(x),
-  CROSSES = function(x) CROSSES(x),
-  WITHIN = function(x) WITHIN(x),
-  CONTAINS = function(x) CONTAINS(x),
-  OVERLAPS = function(x) OVERLAPS(x),
-  RELATE = function(x) RELATE(x),
-  DWITHIN = function(x) DWITHIN(x),
-  BEYOND = function(x) BEYOND(x),
-  CQL = function(x) CQL(x)
+  EQUALS = function(geom) EQUALS(geom),
+  DISJOINT = function(geom) DISJOINT(geom),
+  INTERSECTS = function(geom) INTERSECTS(geom),
+  TOUCHES = function(geom) TOUCHES(geom),
+  CROSSES = function(geom) CROSSES(geom),
+  WITHIN = function(geom) WITHIN(geom),
+  CONTAINS = function(geom) CONTAINS(geom),
+  OVERLAPS = function(geom) OVERLAPS(geom),
+  RELATE = function(geom, pattern) RELATE(geom, pattern),
+  DWITHIN = function(geom, distance, units) DWITHIN(geom, distance, units),
+  BEYOND = function(geom, distance, units) BEYOND(geom, distance, units),
+  BBOX = function(coords, crs) BBOX(coords, crs),
+  CQL = function(...) CQL(...)
 )
 
 # No aggregation functions available in CQL

tests/testthat/test-query-geodata-filter.R

@@ -228,3 +228,12 @@ test_that("a BCGW name works with filter", {
     collect())
   expect_equal(nrow(ret), 367)
 })
+
+test_that("Using BBOX works", {
+  query <- bcdc_query_geodata("WHSE_FOREST_VEGETATION.BEC_BIOGEOCLIMATIC_POLY", crs = 4326) %>%
+    filter(BBOX(c(1639473.0,528785.2,1665979.9,541201.0), crs = "EPSG:3005")) %>%
+    show_query()
+  expect_equal(query$query_list$CQL_FILTER,
+               structure("(BBOX(GEOMETRY, 1639473, 528785.2, 1665979.9, 541201, 'EPSG:3005'))",
+                         class = c("sql", "character")))
+})