From abb0a31febeca8d6bf2777f1f58e5508db586648 Mon Sep 17 00:00:00 2001 From: Thomas Lin Pedersen Date: Fri, 12 Jan 2024 21:03:12 +0100 Subject: [PATCH] re-doc --- man/get_con.Rd | 4 +++- man/get_edges.Rd | 2 +- man/get_nodes.Rd | 3 ++- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/man/get_con.Rd b/man/get_con.Rd index 42b008ae..4136fcb5 100644 --- a/man/get_con.Rd +++ b/man/get_con.Rd @@ -19,7 +19,9 @@ get_con( \item{paths}{A list of integer vectors giving the index of nodes defining connections} -\item{...}{Additional information to be added to the final data output} +\item{...}{Additional information to be added to the final data output. +Accepts expressions that will be evaluated on the node data in it's +original order (irrespective of any reordering by the layout)} \item{weight}{An expression to be evaluated on the edge data to provide weights for the shortest path calculations} diff --git a/man/get_edges.Rd b/man/get_edges.Rd index 8fdb0bf3..2d345a7c 100644 --- a/man/get_edges.Rd +++ b/man/get_edges.Rd @@ -15,7 +15,7 @@ details for a descriptions of the differences} details for more information} \item{...}{Additional data that will be cbind'ed together with the returned -edge data.} +edge data. Accepts expressions that will be evaluated on the edge data} } \value{ A data.frame with columns dependent on format as well as the graph diff --git a/man/get_nodes.Rd b/man/get_nodes.Rd index 88504ef7..9a287a4a 100644 --- a/man/get_nodes.Rd +++ b/man/get_nodes.Rd @@ -8,7 +8,8 @@ get_nodes(...) } \arguments{ \item{...}{Additional data that should be cbind'ed together with the node -data.} +data. Accepts expressions that will be evaluated on the node data in it's +original order (irrespective of any reordering by the layout)} } \value{ A data.frame with the node data as well of any additional data