man/summary.phylo.Rd

   1 \name{summary.phylo}
   2 \alias{summary.phylo}
   3 \alias{Ntip}
   4 \alias{Nnode}
   5 \alias{Nedge}
   6 \title{Print Summary of a Phylogeny}
   7 \usage{
   8 \method{summary}{phylo}(object, \dots)
   9 Ntip(phy)
  10 Nnode(phy, internal.only = TRUE)
  11 Nedge(phy)
  12 }
  13 \arguments{
  14   \item{object, phy}{an object of class \code{"phylo"}.}
  15   \item{...}{further arguments passed to or from other methods.}
  16   \item{internal.only}{a logical indicating whether to return the number
  17     of internal nodes only (the default), or of internal and terminal
  18     (tips) nodes (if \code{FALSE}).}
  19 }
  20 \description{
  21   The first function prints a compact summary of a phylogenetic tree (an
  22   object of class \code{"phylo"}). The three other functions return the
  23   number of tips, nodes, or edges, respectively.
  24 }
  25 \details{
  26   The summary includes the numbers of tips and of nodes, summary
  27   statistics of the branch lengths (if they are available) with mean,
  28   variance, minimum, first quartile, median, third quartile, and
  29   maximum, listing of the first ten tip labels, and (if available) of
  30   the first ten node labels. It is also printed whether some of these
  31   optional elements (branch lengths, node labels, and root edge) are not
  32   found in the tree.
  33
  34   If the tree was estimated by maximum likelihood with
  35   \code{\link{mlphylo}}, a summary of the model fit and the parameter
  36   estimated is printed.
  37
  38   \code{summary} simply prints its results on the standard output and is
  39   not meant for programming.
  40 }
  41 \value{
  42   A NULL value in the case of \code{summary}, a single numeric value for
  43   the three other functions.
  44 }
  45 \author{Emmanuel Paradis \email{Emmanuel.Paradis@mpl.ird.fr}}
  46 \seealso{
  47   \code{\link{read.tree}}, \code{\link[base]{summary}} for the generic R
  48   function
  49 }
  50 \examples{
  51 data(bird.families)
  52 summary(bird.families)
  53 Ntip(bird.families)
  54 Nnode(bird.families)
  55 Nedge(bird.families)
  56 }
  57 \keyword{manip}