Update z funs - document @Rdname

ropensci · Nov 16, 2020 · 9f47694 · 9f47694
1 parent 6b93aaa
commit 9f47694
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 3 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -14,5 +14,8 @@ export(slope_matrix_weighted)
 export(slope_raster)
 export(slope_vector)
 export(slope_z_end)
+export(slope_z_max)
+export(slope_z_mean)
+export(slope_z_min)
 export(slope_z_start)
 export(slope_z_value)
diff --git a/R/z.R b/R/z.R
@@ -39,7 +39,7 @@ slope_z_end = function(x) {
   }
   coords[, "Z"][nrow(coords)]
 }
-#' @rdname slope_z_mean #? or value?
+#' @rdname slope_z_value
 #' @export
 slope_z_mean = function(x) {
   coords = sf::st_coordinates(x)
@@ -48,7 +48,7 @@ slope_z_mean = function(x) {
   }
   mean(coords[, "Z"], na.rm = T)
 }
-#' @rdname slope_z_max
+#' @rdname slope_z_value
 #' @export
 slope_z_max = function(x) {
   coords = sf::st_coordinates(x)
@@ -57,7 +57,7 @@ slope_z_max = function(x) {
   }
   max(coords[, "Z"])
 }
-#' @rdname slope_z_min
+#' @rdname slope_z_value
 #' @export
 slope_z_min = function(x) {
   coords = sf::st_coordinates(x)

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