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

View source: R/RcppExports-manual.R

root_on_nodeR Documentation

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.

outgroup

Integer specifying index of leaf or node to set as the outgroup.

Value

root_on_node() returns phy rooted on the specified node.

Author(s)

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


TreeTools documentation built on June 22, 2024, 9:27 a.m.