docs

NAMESPACE

@@ -6,6 +6,7 @@ export(wkb_problems)
 export(wkb_translate_wkb)
 export(wkb_translate_wkt)
 export(wkt_debug)
+export(wkt_problems)
 export(wkt_streamer_debug)
 export(wkt_translate_wkb)
 export(wkt_translate_wkt)

R/debug.R

@@ -5,17 +5,28 @@
 #' custom C++ handlers and debugging read problems.
 #'
 #' @inheritParams wkb_translate_wkt
-#'
+#' @return The input, invisibly
 #' @export
 #'
+#' @examples
+#' wkt_debug("MULTIPOLYGON (((0 0, 10 0, 0 10, 0 0)))")
+#' wkt_streamer_debug("MULTIPOLYGON (((0 0, 10 0, 0 10, 0 0)))")
+#' wkb_debug(
+#'   wkt_translate_wkb(
+#'     "MULTIPOLYGON (((0 0, 10 0, 0 10, 0 0)))"
+#'   )
+#' )
+#'
 wkb_debug <- function(wkb) {
   cpp_debug_wkb(wkb)
+  invisible(wkb)
 }
 
 #' @rdname wkb_debug
 #' @export
 wkt_debug <- function(wkt) {
   cpp_debug_wkt(wkt)
+  invisible(wkt)
 }
 
 #' @rdname wkb_debug

R/problems.R

@@ -1,12 +1,22 @@
 
-#' Validate well-known binary
+#' Validate well-known binary and well-known text
 #'
 #' @inheritParams wkb_translate_wkt
 #'
 #' @return A character vector of parsing errors. `NA` signifies
 #'   that there was no parsing error.
 #' @export
 #'
+#' @examples
+#' # well-known text
+#' wkt_problems(c("POINT EMTPY", "POINT (20 30)"))
+#'
+#' # well-known binary
+#' wkb <- wkt_translate_wkb("POINT (30 10)", endian = 1)[[1]]
+#' wkb_bad <- wkb
+#' wkb_bad[2] <- as.raw(255)
+#' wkb_problems(list(wkb, wkb_bad))
+#'
 wkb_problems <- function(wkb) {
   cpp_problems_wkb(wkb)
 }

R/translate.R

@@ -25,6 +25,15 @@
 #'   of raw vectors.
 #' @export
 #'
+#' @examples
+#' # translate between WKT and WKB
+#' (wkb <- wkt_translate_wkb("POINT (30 10)"))
+#' wkb_translate_wkt(wkb)
+#'
+#' # some basic creation options are also available
+#' wkt_translate_wkt("POINT (30 10)", trim = FALSE)
+#' wkb_translate_wkb(wkb, endian = 0)
+#'
 wkb_translate_wkt <- function(wkb, include_z = NA, include_m = NA, include_srid = NA,
                               precision = 16, trim = TRUE) {
   cpp_translate_wkb_wkt(

tests/testthat/test-debug.R

@@ -11,6 +11,13 @@ test_that("debugger works on wkb", {
   expect_output(wkb_debug(list(point_bad_type)), "Unrecognized geometry type")
 })
 
+test_that("debugger works on wkt stream", {
+  expect_output(wkt_streamer_debug("LINESTRING (30 10, 0 0, 0 1)"), "LINESTRING")
+  expect_output(wkt_streamer_debug("POLYGON ((30 10, 0 0, 0 1, 30 10))"), "POLYGON")
+  expect_output(wkt_streamer_debug("MULTIPOINT (30 10, 0 0)"), "MULTIPOINT")
+  expect_output(wkt_streamer_debug("MULTIPOINT ((30 10), (0 0))"), "MULTIPOINT")
+})
+
 test_that("debugger works on wkt", {
   expect_output(wkt_debug("LINESTRING (30 10, 0 0, 0 1)"), "LINESTRING")
   expect_output(wkt_debug("POLYGON ((30 10, 0 0, 0 1, 30 10))"), "POLYGON")