NodeOrder: Number of edges incident to each node in a tree

View source: R/tree_properties.R

NodeOrderR Documentation

Number of edges incident to each node in a tree

Description

NodeOrder() calculates the order of each node: the number of edges incident to it in a tree. This value includes the root edge in rooted trees.

Usage

NodeOrder(x, includeAncestor = TRUE, internalOnly = FALSE)

Arguments

x

A tree of class phylo, its ⁠$edge⁠ property, or a list thereof.

includeAncestor

Logical specifying whether to count edge leading to ancestral node in calculation of order.

internalOnly

Logical specifying whether to restrict to results to internal nodes, i.e. to omit leaves. Irrelevant if includeAncestor = FALSE.

Value

NodeOrder() returns an integer listing the order of each node; entries are named with the number of each node.

Author(s)

Martin R. Smith (martin.smith@durham.ac.uk)

See Also

Other tree navigation: AncestorEdge(), CladeSizes(), DescendantEdges(), EdgeAncestry(), EdgeDistances(), ListAncestors(), MRCA(), MatchEdges(), NDescendants(), NodeDepth(), NodeNumbers(), RootNode()

Examples

tree <- CollapseNode(BalancedTree(8), 12:15)
NodeOrder(tree)
plot(tree)
nodelabels(NodeOrder(tree, internalOnly = TRUE))


TreeTools documentation built on Sept. 11, 2024, 8:27 p.m.