Add documentation for edge case

ropensci · Dec 12, 2016 · 8436fde · 8436fde
1 parent 65af7d3
commit 8436fde
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/R/quadrants.R b/R/quadrants.R
@@ -15,6 +15,10 @@
 #' (quads = quadrant(sp_obj))
 #' plot(sp_obj, col = factor(quads))
 #' points(rgeos::gCentroid(sp_obj), col = "white")
+#' # edge cases (e.g. when using rasters) lead to NAs
+#' sp_obj = raster::rasterToPolygons(raster::raster(ncol = 3, nrow = 3))
+#' (quads = quadrant(sp_obj))
+#' plot(sp_obj, col = factor(quads))
 quadrant <- function(sp_obj, number_out = FALSE) {
   cent = rgeos::gCentroid(sp_obj)
   cents = rgeos::gCentroid(sp_obj, byid = TRUE)

diff --git a/man/quadrant.Rd b/man/quadrant.Rd