Improve docs for sequential_dist(), see #32

ropensci · Aug 30, 2021 · 7637f45 · 7637f45
1 parent 18b0a5d
commit 7637f45
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 4 deletions.
diff --git a/R/slopes.R b/R/slopes.R
@@ -69,7 +69,13 @@ slope_distance_weighted = function(d, elevations) {
 #' @param elevations Elevations in same units as x (assumed to be metres).
 #'   Default value: `m[, 3]`, meaning the 'z' coordinate in a matrix of
 #'   coordinates.
-#' @param m Matrix containing coordinates and elevations
+#' @param m Matrix containing coordinates and elevations.
+#'   The matrix should have three columns: x, y, and z. Typically
+#'   these correspond to location in the West-East, South-North, and vertical
+#'   elevation axes respectively.
+#'   In data with geographic coordinates, Z values are assumed to be in
+#'   metres. In data with projected coordinates, Z values are assumed to have
+#'   the same units as the X and Y coordinates.
 #' @inheritParams slope_vector
 #' @inheritParams sequential_dist
 #' @return A vector of slope gradients associated with each linear element

diff --git a/man/elevation_extract.Rd b/man/elevation_extract.Rd
diff --git a/man/sequential_dist.Rd b/man/sequential_dist.Rd
diff --git a/man/slope_matrix.Rd b/man/slope_matrix.Rd