Skip to content

Commit d3fbb5d

Browse files
committed
add roxygen2 family to dists-categorical docs
1 parent 20ae247 commit d3fbb5d

27 files changed

+57
-3
lines changed

Diff for: DESCRIPTION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: dodgr
22
Title: Distances on Directed Graphs
3-
Version: 0.2.10.022
3+
Version: 0.2.10.023
44
Authors@R: c(
55
person("Mark", "Padgham", , "[email protected]", role = c("aut", "cre")),
66
person("Andreas", "Petutschnig", role = "aut"),

Diff for: R/dists-categorical.R

+2
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
#' speed up calculations, but perhaps more importantly it may make possible
3333
#' calculations which would otherwise require distance matrices too large to be
3434
#' directly stored.
35+
#' @family distances
3536
#' @export
3637
dodgr_dists_categorical <- function (graph,
3738
from = NULL,
@@ -158,6 +159,7 @@ dodgr_dists_categorical <- function (graph,
158159
#' @param object A 'dodgr_dists_categorical' object
159160
#' @param ... Extra parameters currently not used
160161
#' @return The summary statistics (invisibly)
162+
#' @family misc
161163
#' @export
162164
summary.dodgr_dists_categorical <- function (object, ...) {
163165

Diff for: codemeta.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"codeRepository": "https://github.com/ATFutures/dodgr",
1111
"issueTracker": "https://github.com/ATFutures/dodgr/issues",
1212
"license": "https://spdx.org/licenses/GPL-3.0",
13-
"version": "0.2.10.022",
13+
"version": "0.2.10.023",
1414
"programmingLanguage": {
1515
"@type": "ComputerLanguage",
1616
"name": "R",

Diff for: man/compare_heaps.Rd

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: man/dodgr_distances.Rd

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: man/dodgr_dists.Rd

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: man/dodgr_dists_categorical.Rd

+14
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: man/dodgr_flowmap.Rd

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: man/dodgr_flows_aggregate.Rd

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: man/dodgr_flows_disperse.Rd

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: man/dodgr_flows_si.Rd

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: man/dodgr_full_cycles.Rd

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: man/dodgr_fundamental_cycles.Rd

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: man/dodgr_insert_vertex.Rd

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: man/dodgr_isochrones.Rd

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: man/dodgr_isodists.Rd

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: man/dodgr_isoverts.Rd

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: man/dodgr_paths.Rd

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: man/dodgr_sample.Rd

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: man/dodgr_sflines_to_poly.Rd

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: man/dodgr_times.Rd

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: man/dodgr_vertices.Rd

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: man/match_points_to_graph.Rd

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: man/match_pts_to_graph.Rd

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: man/merge_directed_graph.Rd

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: man/summary.dodgr_dists_categorical.Rd

+16
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: man/write_dodgr_wt_profile.Rd

+2-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)