man/boot.phylo.Rd

   1 \name{boot.phylo}
   2 \alias{boot.phylo}
   3 \alias{prop.part}
   4 \alias{prop.clades}
   5 \alias{print.prop.part}
   6 \alias{summary.prop.part}
   7 \alias{plot.prop.part}
   8 \title{Tree Bipartition and Bootstrapping Phylogenies}
   9 \usage{
  10 boot.phylo(phy, x, FUN, B = 100, block = 1, trees = FALSE)
  11 prop.part(..., check.labels = FALSE)
  12 prop.clades(phy, ..., part = NULL)
  13 \method{print}{prop.part}(x, ...)
  14 \method{summary}{prop.part}(object, ...)
  15 \method{plot}{prop.part}(x, barcol = "blue", leftmar = 4, ...)
  16 }
  17 \arguments{
  18   \item{phy}{an object of class \code{"phylo"}.}
  19   \item{x}{in the case of \code{boot.phylo}: a taxa (rows) by characters
  20     (columns) matrix; this may be presented as a list; in the case of
  21     \code{print} and \code{plot}: an object of class \code{"prop.part"}.}
  22   \item{FUN}{the function used to estimate \code{phy} (see details).}
  23   \item{B}{the number of bootstrap replicates.}
  24   \item{block}{the number of columns in \code{x} that will be resampled
  25     together (see details).}
  26   \item{trees}{a logical specifying whether to return the bootstraped
  27     trees (\code{FALSE} by default).}
  28   \item{\dots}{either (i) a single object of class \code{"phylo"}, (ii) a
  29     series of such objects separated by commas, or (iii) a list
  30     containing such objects. In the case of \code{plot} further
  31     arguments for the plot (see details).}
  32   \item{check.labels}{a logical specifying whether to check the labels
  33     of each tree. If \code{FALSE} (the default), it is assumed that all
  34     trees have the same tip labels, and that they are in the same order
  35     (see details).}
  36   \item{part}{a list of partitions as returned by \code{prop.part}; if
  37     this is used then \code{\dots} is ignored.}
  38   \item{object}{an object of class \code{"prop.part"}.}
  39   \item{barcol}{the colour used for the bars displaying the number of
  40     partitions in the upper panel.}
  41   \item{leftmar}{the size of the margin on the left to display the tip
  42     labels.}
  43 }
  44 \description{
  45   These functions analyse bipartitions found in a series of trees.
  46
  47   \code{prop.part} counts the number of bipartitions found in a series
  48   of trees given as \code{\dots}.
  49
  50   \code{prop.clades} counts the number of times the bipartitions present
  51   in \code{phy} are present in a series of trees given as \code{\dots} or
  52   in the list previously computed and given with \code{part}.
  53
  54   \code{boot.phylo} performs a bootstrap analysis.
  55 }
  56 \details{
  57   The argument \code{FUN} in \code{boot.phylo} must be the function used
  58   to estimate the tree from the original data matrix. Thus, if the tree
  59   was estimated with neighbor-joining (see \code{nj}), one maybe wants
  60   something like \code{FUN = function(xx) nj(dist.dna(xx))}.
  61
  62   \code{block} in \code{boot.phylo} specifies the number of columns to
  63   be resampled altogether. For instance, if one wants to resample at the
  64   codon-level, then \code{block = 3} must be used.
  65
  66   Using (the default) \code{check.labels = FALSE} in \code{prop.part}
  67   results in considerable decrease in computing times. This requires that
  68   (i) all trees have the same tip labels, \emph{and} (ii) these labels
  69   are ordered similarly in all trees (in other words, the element
  70   \code{tip.label} are identical in all trees).
  71
  72   The plot function represents a contingency table of the different
  73   partitions (on the \emph{x}-axis) in the lower panel, and their observed
  74   numbers in the upper panel. Any further arguments (\dots) are used to
  75   change the aspects of the points in the lower panel: these may be
  76   \code{pch}, \code{col}, \code{bg}, \code{cex}, etc. This function
  77   works only if there is an attribute \code{labels} in the object.
  78
  79   The print method displays the partitions and their numbers. The
  80   summary method extracts the numbers only.
  81 }
  82 \note{
  83   \code{prop.clades} calls internally \code{prop.part} with the option
  84   \code{check.labels = TRUE}, which may be very slow. If the trees
  85   passed as \code{\dots} fulfills conditions (i) and (ii) above, then it
  86   might be faster to first call, e.g., \code{pp <- prop.part(...)}, then
  87   use the option \code{part}: \code{prop.clades(phy, part = pp)}.
  88 }
  89 \value{
  90   \code{prop.part} returns an object of class \code{"prop.part"} which
  91   is a list with an attribute \code{"number"}. The elements of this list
  92   are the observed clades, and the attribute their respective
  93   numbers. If the default \code{check.labels = FALSE} is used, an
  94   attribute \code{"labels"} is added, and the vectors of the returned
  95   object contains the indices of these labels instead of the labels
  96   themselves.
  97
  98   \code{prop.clades} and \code{boot.phylo} return a numeric vector
  99   which \emph{i}th element is the number associated to the \emph{i}th
 100   node of \code{phy}. If \code{trees = TRUE}, \code{boot.phylo} returns
 101   a list whose first element (named \code{"BP"}) is like before, and the
 102   second element (\code{"trees"}) is a list with the bootstraped
 103   trees.
 104
 105   \code{summary} returns a numeric vector.
 106 }
 107 \references{
 108   Efron, B., Halloran, E. and Holmes, S. (1996) Bootstrap confidence
 109   levels for phylogenetic trees. \emph{Proceedings of the National
 110     Academy of Sciences USA}, \bold{93}, 13429--13434.
 111
 112   Felsenstein, J. (1985) Confidence limits on phylogenies: an approach
 113   using the bootstrap. \emph{Evolution}, \bold{39}, 783--791.
 114 }
 115 \author{Emmanuel Paradis \email{Emmanuel.Paradis@mpl.ird.fr}}
 116 \seealso{
 117   \code{\link{dist.topo}}, \code{\link{consensus}}, \code{\link{nodelabels}}
 118 }
 119 \examples{
 120 data(woodmouse)
 121 tr <- nj(dist.dna(woodmouse))
 122 ### Are bootstrap values stable?
 123 for (i in 1:5)
 124   print(boot.phylo(tr, woodmouse, function(xx) nj(dist.dna(xx))))
 125 ### How many partitions in 100 random trees of 10 labels?...
 126 TR <- replicate(100, rtree(10), FALSE)
 127 pp10 <- prop.part(TR)
 128 length(pp10)
 129 ### ... and in 100 random trees of 20 labels?
 130 TR <- replicate(100, rtree(20), FALSE)
 131 pp20 <- prop.part(TR)
 132 length(pp20)
 133 plot(pp10, pch = "x", col = 2)
 134 plot(pp20, pch = "x", col = 2)
 135 }
 136 \keyword{manip}
 137 \keyword{htest}