docs: add st_erase example

elipousson · Sep 15, 2023 · 29f2846 · 29f2846
1 parent 03f03ea
commit 29f2846
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 8 deletions.
diff --git a/R/st_erase.R b/R/st_erase.R
@@ -13,7 +13,7 @@
 #' @param union If `TRUE`, use [sf::st_combine()] and [sf::st_union()] on y
 #'   before applying difference/intersection; defaults to `TRUE`.
 #' @inheritParams sf::st_difference
-#' @examples examples/st_erase.R
+#' @example examples/st_erase.R
 #' @export
 #' @importFrom sf st_union st_combine st_intersection st_difference
 st_erase <- function(x, y, flip = FALSE, union = TRUE, combine = FALSE, ...) {

diff --git a/examples/st_erase.R b/examples/st_erase.R
@@ -0,0 +1,19 @@
+nc <- read_sf_ext(system.file("shape/nc.shp", package = "sf"))
+
+nc <- st_transform_ext(nc, 3657)
+
+plot(
+  st_erase(
+    st_buffer(nc[1, ], 1000),
+    nc[1, ]
+  ),
+  max.plot = 1
+)
+
+plot(
+  st_trim(
+    nc,
+    st_buffer(nc[1, ], 2000)
+  ),
+  max.plot = 1
+)
diff --git a/man/st_erase.Rd b/man/st_erase.Rd