docs for #77

dcooley · Apr 16, 2020 · 430fe13 · 430fe13
1 parent 890a464
commit 430fe13
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 0 deletions.
diff --git a/R/sfc.R b/R/sfc.R
@@ -420,6 +420,24 @@ calculate_bbox.default <- function( obj, x = NULL, y = NULL ) {
 #'
 #' @params obj sf, sfc or sfg object
 #'
+#' @examples
+#'
+#' df <- data.frame(
+#'  id1 = c(1,1,1,1,1,1,1,1,2,2,2,2)
+#'  , id2 = c(1,1,1,1,2,2,2,2,1,1,1,1)
+#'  , x = c(0,0,1,1,1,1,2,2,3,4,4,3)
+#'  , y = c(0,1,1,0,1,2,2,1,3,3,4,4)
+#' )
+#'
+#' sf_line <- sfheaders::sf_linestring(
+#'   obj = df
+#'   , x = "x"
+#'   , y = "y"
+#'   , linestring_id = "id1"
+#' )
+#'
+#' sf_boxes( sf_line )
+#'
 #' @export
 sf_boxes <- function( obj ) calculate_boxes( obj )
 

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