root_on_node: Wrapper for internal C function 'root_on_node()'

In TreeTools: Create, Modify and Analyse Phylogenetic Trees

Wrapper for internal C function root_on_node()

Description

Direct entry point to root_on_node(); recommended for expert use only. RootTree() checks that input is properly formatted and is recommended for general use.

Usage

root_on_node(phy, outgroup)

Arguments

phy	Minimally, a named list with entries edge and Nnode, in the format of equivalent entries in a tree of class phylo. edge.length will also be considered if supplied. The root node must be numbered n_tip + 1.
outgroup	Integer specifying index of leaf or node to set as the outgroup.

Details

phy may be supplied in any valid edge order.

Value

root_on_node() returns phy rooted on the specified node, in preorder, with nodes renumbered accordingly.

Author(s)

Martin R. Smith ([e-mail])

TreeTools documentation built on Sept. 10, 2026, 5:10 p.m.