colless.phylo: Colless number

Description Usage Arguments Value Author(s) Examples

View source: R/colless.R

Description

Finds the Colless number for a tree. Note that the package apTreeshape has a function colless to compute the Colless imbalance with additional options to normalise it based on the model; we include this simple function here for convenience within this package, and for use on objects of class phylo and phylo4.

Usage

1
colless.phylo(tree, normalise = TRUE)

Arguments

tree

a tree of class phylo or phylo4. The tree should be binary and rooted; if not it will be coerced into a binary rooted tree using multi2di, if possible.

normalise

option to normalise the result by dividing by the number of tip pairs. Defaults to TRUE.

Value

The Colless imbalance number of the tree.

Author(s)

Michael Boyd [email protected]

Michelle Kendall [email protected]

Examples

1
2
3
4
## Find the Colless imbalance of a random tree with 10 tips:
tree <- rtree(10)
plot(tree)
colless.phylo(tree)

phyloTop documentation built on Feb. 22, 2018, 1:03 a.m.