Add back examples with package data

R/inside_polygon.R

@@ -16,7 +16,17 @@
 #' @importFrom concaveman concaveman
 #' @importFrom tidyr pivot_longer
 #' @export
-
+#' @examples
+#' x3p <- x3p_subsamples[[1]]
+#' bounds <- x3p_boundary_points(x3p, 2)
+#' polygon <- inside_polygon(bounds$x, bounds$y, 1)
+#'
+#' library(ggplot2)
+#' library(dplyr)
+#' bounds %>%
+#' ggplot(aes(x = x, y = y)) + geom_point() +
+#'   geom_polygon(data = polygon)
+#'
 inside_polygon <- function(x, y, concavity, center = NULL) {
   stopifnot(concavity > 0)
 

R/x3p_boundary_points.R

@@ -9,7 +9,16 @@
 #' @importFrom dplyr `%>%` group_by mutate filter summarize select
 #' @importFrom rlang .data
 #' @export
-
+#' @examples
+#' x3p <- x3p_subsamples[[1]]
+#' bounds <- x3p_boundary_points(x3p, 2)
+#'
+#' library(ggplot2)
+#' library(dplyr)
+#' bounds %>%
+#' ggplot(aes(x = x, y = y)) +
+#' geom_point()
+#'
 x3p_boundary_points <- function(x3p, sample) {
   stopifnot("x3p" %in% class(x3p))
   x3p_df <- x3p %>%

R/x3p_surface_polygon.R

@@ -16,7 +16,12 @@
 #' @importFrom grDevices as.raster dev.off
 #' @importFrom graphics par plot.default polygon
 #' @export
-
+#' @examples
+#' if (interactive()) {
+#'   x3p <- x3p_subsamples[[1]]
+#'   x3p <- x3p %>% x3p_surface_polygon(sample=1)
+#'   x3p_image(x3p, size = dim(x3p$surface.matrix), zoom=.6)
+#' }
 x3p_surface_polygon <- function(x3p, colour = "red", sample = 10, center = NULL, concavity = 1.5) {
   stopifnot("x3p" %in% class(x3p), is.numeric(concavity), concavity > 0)