man/print.phylo.Rd

   1 \name{print.phylo}
   2 \alias{print.phylo}
   3 \alias{print.multiPhylo}
   4 \alias{[.multiPhylo}
   5 \alias{[[.multiPhylo}
   6 \alias{$.multiPhylo}
   7 \alias{str.multiPhylo}
   8 \title{Compact Display of a Phylogeny}
   9 \usage{
  10 \method{print}{phylo}(x, printlen = 6 ,...)
  11 \method{print}{multiPhylo}(x, details = FALSE ,...)
  12 \method{[}{multiPhylo}(x, i)
  13 \method{[[}{multiPhylo}(x, i)
  14 \method{$}{multiPhylo}(x, name)
  15 \method{str}{multiPhylo}(object, ...)
  16 }
  17 \arguments{
  18   \item{x}{an object of class \code{"phylo"} or \code{"multiPhylo"}.}
  19   \item{object}{an object of class \code{"multiPhylo"}.}
  20   \item{printlen}{the number of labels to print (6 by default).}
  21   \item{details}{a logical indicating whether to print information on
  22     all trees.}
  23   \item{i}{indices of the tree(s) to select from a list; this may be a
  24     vector of integers, logicals, or names.}
  25   \item{name}{a character string specifying the tree to be extracted.}
  26   \item{\dots}{further arguments passed to or from other methods.}
  27 }
  28 \description{
  29   These functions prints a compact summary of a phylogeny, or a list of
  30   phylogenies, on the console.
  31
  32   The operators \code{[}, \code{[[}, and \code{$} propagate the class
  33   correctly.
  34 }
  35 \value{
  36   An object of class \code{"phylo"} (\code{[[}, \code{$}) or of class
  37   \code{"multiPhylo"} (\code{[}), or NULL.
  38 }
  39 \author{Ben Bolker \email{bolker@zoo.ufl.edu} and Emmanuel Paradis
  40   \email{Emmanuel.Paradis@mpl.ird.fr}}
  41 \seealso{
  42   \code{\link{read.tree}}, \code{\link{summary.phylo}},
  43   \code{\link[base]{print}} for the generic R function
  44 }
  45 \keyword{manip}