File: balance.Rd

package info (click to toggle)
r-cran-ape 5.7-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 3,932 kB
  • sloc: ansic: 7,626; cpp: 116; sh: 17; makefile: 2
file content (29 lines) | stat: -rw-r--r-- 1,036 bytes parent folder | download | duplicates (8)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
\name{balance}
\alias{balance}
\title{Balance of a Dichotomous Phylogenetic Tree}
\usage{
balance(phy)
}
\arguments{
  \item{phy}{an object of class \code{"phylo"}.}
}
\description{
  This function computes the balance of a phylogenetic tree, that is for
  each node of the tree the numbers of descendants (i.e. tips) on each
  of its daughter-branch. The tree must be fully dichotomous.
}
\value{
  a numeric matrix with two columns and one row for each node of the
  tree. The columns give the numbers of descendants on each
  daughter-branches (the order of both columns being arbitrary). If the
  phylogeny \code{phy} has an element \code{node.label}, this is used as
  rownames for the returned matrix; otherwise the numbers (of mode
  character) of the matrix \code{edge} of \code{phy} are used as rownames.
}
\references{
  Aldous, D. J. (2001) Stochastic models and descriptive statistics for
  phylogenetic trees, from Yule to today. \emph{Statistical Science},
  \bold{16}, 23--34.
}
\author{Emmanuel Paradis}
\keyword{manip}