]> git.donarmstrong.com Git - ape.git/blob - man/fastme.Rd
897ffa0942313637d415e880943f9ebac2abe5d7
[ape.git] / man / fastme.Rd
1 \name{FastME}
2 \alias{fastme}
3 \alias{fastme.bal}
4 \alias{fastme.ols}
5 \title{
6   Tree Estimation Based on the Minimum Evolution Algorithm
7 }
8 \description{
9   The two FastME functions (balanced and OLS) perform the
10   Minimum Evolution algorithm of Desper and Gascuel (2002).
11 }
12 \usage{
13   fastme.bal(X, nni = TRUE)
14   fastme.ols(X, nni = TRUE)
15 }
16 \arguments{
17   \item{X}{a distance matrix; may be an object of class \code{"dist"}.}
18   \item{nni}{a boolean value; TRUE to do NNIs (default).}
19 }
20 \value{
21   an object of class \code{"phylo"}.
22 }
23 \references{
24   Desper, R. and Gascuel, O. (2002) Fast and accurate phylogeny
25   reconstruction algorithms based on the minimum-evolution principle.
26   \emph{Journal of Computational Biology}, \bold{9(5)}, 687--705.
27 }
28 \author{
29   original C code by Richard Desper; adapted and ported to R
30   by Vincent Lefort \email{vincent.lefort@lirmm.fr}
31 }
32 \seealso{
33   \code{\link{nj}}, \code{\link{bionj}},
34   \code{\link{write.tree}}, \code{\link{read.tree}},
35   \code{\link{dist.dna}}, \code{\link{mlphylo}}
36 }
37 \examples{
38 ### From Saitou and Nei (1987, Table 1):
39 x <- c(7, 8, 11, 13, 16, 13, 17, 5, 8, 10, 13,
40        10, 14, 5, 7, 10, 7, 11, 8, 11, 8, 12,
41        5, 6, 10, 9, 13, 8)
42 M <- matrix(0, 8, 8)
43 M[row(M) > col(M)] <- x
44 M[row(M) < col(M)] <- x
45 rownames(M) <- colnames(M) <- 1:8
46 tr <- fastme.bal(M)
47 plot(tr, "u")
48 ### a less theoretical example
49 data(woodmouse)
50 trw <- fastme.bal(dist.dna(woodmouse))
51 plot(trw)
52 }
53 \keyword{models}
54