From 234ee321312c1039e85c5857213cf0e7246af0ba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Tue, 25 Mar 2025 12:06:22 +0100 Subject: [PATCH 1/2] docs: better describe output of `all_shortest_paths()` --- R/structural-properties.R | 17 +++++++++++++---- man/aaa-igraph-package.Rd | 2 +- man/distances.Rd | 17 +++++++++++++---- 3 files changed, 27 insertions(+), 9 deletions(-) diff --git a/R/structural-properties.R b/R/structural-properties.R index 3d9df23d28a..daafe94683a 100644 --- a/R/structural-properties.R +++ b/R/structural-properties.R @@ -789,10 +789,19 @@ degree_distribution <- function(graph, cumulative = FALSE, ...) { #' was not requested.} \item{inbound_edges}{Numeric vector, the inbound edge #' for each vertex, or `NULL`, if it was not requested.} #' -#' For `all_shortest_paths()` a list is returned, each list element -#' contains a shortest path from `from` to a vertex in `to`. The -#' shortest paths to the same vertex are collected into consecutive elements -#' of the list. +#' For `all_shortest_paths()` a list is returned: +#' \describe{ +#' \item{vpaths}{This is a list. Each list element +#' contains the vertices of a shortest path from `from` to a vertex in `to`. +#' The shortest paths to the same vertex are collected +#' into consecutive elements of the list.} +#' \item{epaths}{This is a list similar to vpaths, +#' but the vectors of the list contain the edge ids along the shortest paths, +#' instead of the vertex ids.} +#' \item{nrgeo}{A vector in which each element is the number of shortest paths +#' (geodesics) from `from` to the corresponding vertex in `to`.} +#' \item{res}{Deprecated} +#' } #' #' For `mean_distance()` a single number is returned if `details=FALSE`, #' or a named list with two entries: `res` is the mean distance as a numeric diff --git a/man/aaa-igraph-package.Rd b/man/aaa-igraph-package.Rd index bb43e290c5f..89fa18a3521 100644 --- a/man/aaa-igraph-package.Rd +++ b/man/aaa-igraph-package.Rd @@ -195,7 +195,7 @@ Authors: Other contributors: \itemize{ \item Michael Antonov [contributor] - \item Chan Zuckerberg Initiative (02qenvm24) [funder] + \item Chan Zuckerberg Initiative (\href{https://ror.org/02qenvm24}{ROR}) [funder] } } diff --git a/man/distances.Rd b/man/distances.Rd index aa3ebe96038..697ab0e61db 100644 --- a/man/distances.Rd +++ b/man/distances.Rd @@ -144,10 +144,19 @@ predecessor of each vertex in the \code{to} argument, or \code{NULL} if it was not requested.} \item{inbound_edges}{Numeric vector, the inbound edge for each vertex, or \code{NULL}, if it was not requested.} -For \code{all_shortest_paths()} a list is returned, each list element -contains a shortest path from \code{from} to a vertex in \code{to}. The -shortest paths to the same vertex are collected into consecutive elements -of the list. +For \code{all_shortest_paths()} a list is returned: +\describe{ +\item{vpaths}{This is a list. Each list element +contains the vertices of a shortest path from \code{from} to a vertex in \code{to}. +The shortest paths to the same vertex are collected +into consecutive elements of the list.} +\item{epaths}{This is a list similar to vpaths, +but the vectors of the list contain the edge ids along the shortest paths, +instead of the vertex ids.} +\item{nrgeo}{A vector in which each element is the number of shortest paths +(geodesics) from \code{from} to the corresponding vertex in \code{to}.} +\item{res}{Deprecated} +} For \code{mean_distance()} a single number is returned if \code{details=FALSE}, or a named list with two entries: \code{res} is the mean distance as a numeric From 0bd588b40fd6292056b60c9a1c0d178f74532260 Mon Sep 17 00:00:00 2001 From: maelle Date: Tue, 25 Mar 2025 11:32:31 +0000 Subject: [PATCH 2/2] chore: Auto-update from GitHub Actions Run: https://github.com/igraph/rigraph/actions/runs/14058469618 --- man/aaa-igraph-package.Rd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/man/aaa-igraph-package.Rd b/man/aaa-igraph-package.Rd index 89fa18a3521..bb43e290c5f 100644 --- a/man/aaa-igraph-package.Rd +++ b/man/aaa-igraph-package.Rd @@ -195,7 +195,7 @@ Authors: Other contributors: \itemize{ \item Michael Antonov [contributor] - \item Chan Zuckerberg Initiative (\href{https://ror.org/02qenvm24}{ROR}) [funder] + \item Chan Zuckerberg Initiative (02qenvm24) [funder] } }