]> git.donarmstrong.com Git - ape.git/blob - man/balance.Rd
bee8d256803f8cfebc4f68406950ee38ad2f64f6
[ape.git] / man / balance.Rd
1 \name{balance}
2 \alias{balance}
3 \title{Balance of a Dichotomous Phylogenetic Tree}
4 \usage{
5 balance(phy)
6 }
7 \arguments{
8   \item{phy}{an object of class \code{"phylo"}.}
9 }
10 \description{
11   This function computes the balance of a phylogenetic tree, that is for
12   each node of the tree the numbers of descendants (i.e. tips) on each
13   of its daughter-branch. The tree must be fully dichotomous.
14 }
15 \value{
16   a numeric matrix with two columns and one row for each node of the
17   tree. The columns give the numbers of descendants on each
18   daughter-branches (the order of both columns being arbitrary). If the
19   phylogeny \code{phy} has an element \code{node.label}, this is used as
20   rownames for the returned matrix; otherwise the numbers (of mode
21   character) of the matrix \code{edge} of \code{phy} are used as rownames.
22 }
23 \references{
24   Aldous, D. J. (2001) Stochastic models and descriptive statistics for
25   phylogenetic trees, from Yule to today. \emph{Statistical Science},
26   \bold{16}, 23--34.
27 }
28 \author{Emmanuel Paradis \email{Emmanuel.Paradis@mpl.ird.fr}}
29 \keyword{manip}