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, spr = TRUE, tbr = 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   \item{spr}{ditto for SPRs.}
  20   \item{tbr}{ditto for TBRs.}
  21 }
  22 \value{
  23   an object of class \code{"phylo"}.
  24 }
  25 \references{
  26   Desper, R. and Gascuel, O. (2002) Fast and accurate phylogeny
  27   reconstruction algorithms based on the minimum-evolution principle.
  28   \emph{Journal of Computational Biology}, \bold{9(5)}, 687--705.
  29 }
  30 \author{
  31   original C code by Richard Desper; adapted and ported to R
  32   by Vincent Lefort \email{vincent.lefort@lirmm.fr}
  33 }
  34 \seealso{
  35   \code{\link{nj}}, \code{\link{bionj}},
  36   \code{\link{write.tree}}, \code{\link{read.tree}},
  37   \code{\link{dist.dna}}
  38 }
  39 \examples{
  40 ### From Saitou and Nei (1987, Table 1):
  41 x <- c(7, 8, 11, 13, 16, 13, 17, 5, 8, 10, 13,
  42        10, 14, 5, 7, 10, 7, 11, 8, 11, 8, 12,
  43        5, 6, 10, 9, 13, 8)
  44 M <- matrix(0, 8, 8)
  45 M[row(M) > col(M)] <- x
  46 M[row(M) < col(M)] <- x
  47 rownames(M) <- colnames(M) <- 1:8
  48 tr <- fastme.bal(M)
  49 plot(tr, "u")
  50 ### a less theoretical example
  51 data(woodmouse)
  52 trw <- fastme.bal(dist.dna(woodmouse))
  53 plot(trw)
  54 }
  55 \keyword{models}
  56