create new roxygen2 family for match functions for #103

UrbanAnalyst · Aug 11, 2022 · dbdfee2 · dbdfee2
1 parent 09485ca
commit dbdfee2
Show file tree

Hide file tree

Showing 20 changed files with 54 additions and 132 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: dodgr
 Title: Distances on Directed Graphs
-Version: 0.2.14.088
+Version: 0.2.14.090
 Authors@R: c(
     person("Mark", "Padgham", , "[email protected]", role = c("aut", "cre")),
     person("Andreas", "Petutschnig", role = "aut"),

diff --git a/R/match-points.R b/R/match-points.R
@@ -15,7 +15,7 @@
 #' matching.
 #'
 #' @return A vector index into verts
-#' @family misc
+#' @family match
 #' @export
 #' @examples
 #' net <- weight_streetnet (hampi, wt_profile = "foot")
@@ -60,7 +60,7 @@ match_pts_to_verts <- function (verts, xy, connected = FALSE) {
 #'
 #' Alias for \link{match_pts_to_verts}
 #' @inherit match_pts_to_verts
-#' @family misc
+#' @family match
 #' @export
 match_points_to_verts <- function (verts, xy, connected = FALSE) {
 
@@ -117,7 +117,7 @@ pre_process_xy <- function (xy) {
 #' @return A vector index matching the `xy` coordinates to nearest edges. For
 #' bi-directional edges, only one match is returned, and it is up to the user to
 #' identify and suitably process matching edge pairs.
-#' @family misc
+#' @family match
 #' @export
 #' @examples
 #' graph <- weight_streetnet (hampi, wt_profile = "foot")
@@ -155,7 +155,7 @@ match_pts_to_graph <- function (graph, xy, connected = FALSE) {
 #'
 #' Alias for \link{match_pts_to_graph}
 #' @inherit match_pts_to_graph
-#' @family misc
+#' @family match
 #' @export
 match_points_to_graph <- function (graph, xy, connected = FALSE) {
 
@@ -174,7 +174,21 @@ match_points_to_graph <- function (graph, xy, connected = FALSE) {
 #' @return A modified version of `graph`, with additional edges formed by
 #' breaking previous edges at nearest penpendicular intersections with the
 #' points, `xy`.
-#' @family misc
+#' @family match
+#' @examples
+#' graph <- weight_streetnet (hampi, wt_profile = "foot")
+#' dim (graph)
+#'
+#' verts <- dodgr_vertices (graph)
+#' set.seed (2)
+#' npts <- 10
+#' xy <- data.frame (
+#'     x = min (verts$x) + runif (npts) * diff (range (verts$x)),
+#'     y = min (verts$y) + runif (npts) * diff (range (verts$y))
+#' )
+#'
+#' graph <- add_nodes_to_graph (graph, xy)
+#' dim (graph) # more edges than original
 #' @export
 add_nodes_to_graph <- function (graph, xy) {
 

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -20,6 +20,9 @@ reference:
 - title: Graph Centrality
   contents:
   - has_concept("centrality")
+- title: Matching Points to Graphs
+  contents:
+  - has_concept("match")
 - title: Miscellaneous Functions
   contents:
   - has_concept("misc")

diff --git a/codemeta.json b/codemeta.json
@@ -7,7 +7,7 @@
   "codeRepository": "https://github.com/ATFutures/dodgr",
   "issueTracker": "https://github.com/ATFutures/dodgr/issues",
   "license": "https://spdx.org/licenses/GPL-3.0",
-  "version": "0.2.14.088",
+  "version": "0.2.14.090",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",

diff --git a/man/add_nodes_to_graph.Rd b/man/add_nodes_to_graph.Rd
diff --git a/man/compare_heaps.Rd b/man/compare_heaps.Rd
diff --git a/man/dodgr_flowmap.Rd b/man/dodgr_flowmap.Rd
diff --git a/man/dodgr_full_cycles.Rd b/man/dodgr_full_cycles.Rd
diff --git a/man/dodgr_fundamental_cycles.Rd b/man/dodgr_fundamental_cycles.Rd
diff --git a/man/dodgr_insert_vertex.Rd b/man/dodgr_insert_vertex.Rd
diff --git a/man/dodgr_sample.Rd b/man/dodgr_sample.Rd
diff --git a/man/dodgr_sflines_to_poly.Rd b/man/dodgr_sflines_to_poly.Rd
diff --git a/man/dodgr_vertices.Rd b/man/dodgr_vertices.Rd
diff --git a/man/match_points_to_graph.Rd b/man/match_points_to_graph.Rd
diff --git a/man/match_points_to_verts.Rd b/man/match_points_to_verts.Rd
diff --git a/man/match_pts_to_graph.Rd b/man/match_pts_to_graph.Rd
diff --git a/man/match_pts_to_verts.Rd b/man/match_pts_to_verts.Rd
diff --git a/man/merge_directed_graph.Rd b/man/merge_directed_graph.Rd