TreeTools (version 1.4.4)

UnshiftTree: Add tree to start of list

Description

UnshiftTree() adds a phylogenetic tree to the start of a list of trees. This is useful where the class of a list of trees is unknown, or where names of trees should be retained.

Usage

UnshiftTree(add, treeList)

Arguments

add

Tree to add to the list, of class phylo.

treeList

A list of trees, of class list, multiPhylo, or, if a single tree, phylo.

Value

UnshiftTree() returns a list of class list or multiPhylo (following the original class of treeList), whose first element is the tree specified as `add.

Details

Caution: adding a tree to a multiPhylo object whose own attributes apply to all trees, for example trees read from a Nexus file, causes data to be lost.

See Also

c() joins a tree or series of trees to a multiPhylo object, but loses names and does not handle lists of trees.

Examples

# NOT RUN {
forest <- as.phylo(0:5, 6)
tree <- BalancedTree(6)

UnshiftTree(tree, forest)
UnshiftTree(tree, tree)
# }