root_tree.phylo: Root tree given three tips

root_tree.phyloR Documentation

Root tree given three tips

Description

This function roots a phylogenetic tree given three tip labels.

Usage

root_tree.phylo(tree, tips, edge_label = F)

Arguments

tree

An object of class phylo

tips

Three tip labels

Details

Tips a, b and c define exactly one internal node in the unrooted tree. The tree will be rooted on the branch leading from this node to tip a.

By default, node/tip labels are interpreted as vertex labels, not edge labels. When the labels actually represent edge labels (e.g., branch support values), set edge_label to TRUE. This will make sure that the edge labels are handled correctly, i.e. moved to the correct nodes. In that case, when the tree is rooted on a non-tip branch, its edge label will be copied to both child nodes of the new root node.

Value

An object of class phylo


SWittouck/tidygenomes documentation built on June 1, 2024, 9:40 p.m.