]> git.donarmstrong.com Git - ape.git/blob - man/consensus.Rd
bbedf3706d11cf6f30b63e57c227db3527bedbf5
[ape.git] / man / consensus.Rd
1 \name{consensus}
2 \alias{consensus}
3 \title{Concensus Trees}
4 \usage{
5 consensus(..., p = 1, check.labels = TRUE)
6 }
7 \arguments{
8   \item{\dots}{either (i) a single object of class \code{"phylo"}, (ii) a
9     series of such objects separated by commas, or (iii) a list
10     containing such objects.}
11   \item{p}{a numeric value between 0.5 and 1 giving the proportion for a
12     clade to be represented in the consensus tree.}
13   \item{check.labels}{a logical specifying whether to check the labels
14     of each tree. If \code{FALSE} (the default), it is assumed that all
15     trees have the same tip labels, and that they are in the same order
16     (see details).}
17 }
18 \description{
19   Given a series of trees, this function returns the consensus tree. By
20   default, the strict-consensus tree is computed. To get the
21   majority-rule consensus tree, use \code{p = 0.5}. Any value between
22   0.5 and 1 can be used.
23 }
24 \details{
25   Using \code{check.labels = FALSE} results in
26   considerable decrease in computing times. This requires that all
27   trees have the same tip labels, \emph{and} these labels are
28   ordered similarly in all trees (in other words, the element
29   \code{tip.label} are identical in all trees).
30 }
31 \value{
32   an object of class \code{"phylo"}.
33 }
34 \author{Emmanuel Paradis \email{Emmanuel.Paradis@mpl.ird.fr}}
35 \seealso{
36   \code{\link{prop.part}}, \code{\link{dist.topo}}
37 }
38 \keyword{manip}