graph.nodes: Return root, end, or branchpoints of an igraph object

In jefferis/nat: NeuroAnatomy Toolbox for Analysis of 3D Image Data

Return root, end, or branchpoints of an igraph object

Description

Return root, end, or branchpoints of an igraph object

Usage

graph.nodes(
  x,
  type = c("root", "end", "branch"),
  original.ids = "name",
  exclude.isolated = TRUE
)

Arguments

x	An ngraph or raw igraph object
type	one of root, end (which includes root) or branch
original.ids	Use named attribute to return original vertex ids (when available). Set to FALSE when this is not desired.
exclude.isolated	Do not count isolated vertices as root/end points (default)

Details

This function underlies rootpoints.igraph methods and friends. It is conceived of as slightly lower level and end users would normally use the rootpoints methods.

graph.nodes should work for any igraph object (including ngraph objects, which inherit from igraph). However the graph must be directed in order to return a root point

See Also

rootpoints, ngraph

Examples

ng=as.ngraph(Cell07PNs[[1]])
# set some arbitrary vertex identifiers
igraph::vertex_attr(ng, 'name') <-sample(500, nvertices(ng))
# return those identifiers
graph.nodes(ng, type = 'end')
# ... or raw vertex indices
graph.nodes(ng,type = 'end', original.ids = FALSE)

jefferis/nat documentation built on Feb. 22, 2024, 12:45 p.m.