improve docs of dists_proportional for #144

UrbanAnalyst · Sep 12, 2021 · e47fc28 · e47fc28
1 parent d4c606e
commit e47fc28
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 4 deletions.
diff --git a/R/dists-proportional.R b/R/dists-proportional.R
@@ -3,12 +3,16 @@
 #' @inheritParams dodgr_dists
 #' @param graph `data.frame` or equivalent object representing the network
 #' graph which must have a column named "edge_type" with integer types along
-#' which proportional distances are to be aggregated. The value of "edge_type" =
-#' 0 is the default type for which proportional distances are not aggregated.
+#' which proportional distances are to be aggregated (see Note).
 #' @return A list of distance matrices of equal dimensions (length(from),
 #' length(to)), the first of which ("distance") holds the final distances, while
 #' the rest are one matrix for each unique value of "edge_type", holding the
 #' distances traversed along those types of edges only.
+#'
+#' @note The "edge_type" column in the graph must be labelled with sequential
+#' integer values: The first type should have a value of 1; the second a value
+#' of 2; and so on. Values of 0 can be used to flag "default" edges for which
+#' distances are not to be aggregated.
 #' @export
 dodgr_dists_proportional <- function (graph,
                                       from = NULL,

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