man/is.ultrametric.Rd

   1 \name{is.ultrametric}
   2 \alias{is.ultrametric}
   3 \title{Test if a Tree is Ultrametric}
   4 \usage{
   5 is.ultrametric(phy, tol = .Machine$double.eps^0.5)
   6 }
   7 \arguments{
   8   \item{phy}{an object of class \code{"phylo"}.}
   9   \item{tol}{a numeric >= 0, variation below this value are considered
  10     non-significant (see details).}
  11 }
  12 \description{
  13   This function computes the distances from each tip to the root: if the
  14   variance of these distances is null, the tree is considered as
  15   ultrametric.
  16 }
  17 \value{
  18   a logical: \code{TRUE} if the tree is ultrametric, \code{FALSE}
  19   otherwise.
  20 }
  21 \details{
  22   The default value for \code{tol} is based on the numerical
  23   characteristics of the machine R is running on.
  24 }
  25 \author{Emmanuel Paradis \email{Emmanuel.Paradis@mpl.ird.fr}}
  26 \seealso{
  27   \code{\link{is.binary.tree}}, \code{\link[base]{.Machine}}
  28 }
  29 \keyword{utilities}