]> git.donarmstrong.com Git - ape.git/blobdiff - man/print.phylo.Rd
moved functions from ape to pegas -> ape 2.4
[ape.git] / man / print.phylo.Rd
index f0b83a462b517a6ac141489092fcd246374dd89a..1d216b3e6f69fe50cd8416e7ef73f1ffefc55dd0 100644 (file)
@@ -2,27 +2,39 @@
 \alias{print.phylo}
 \alias{print.multiPhylo}
 \alias{[.multiPhylo}
+\alias{[[.multiPhylo}
+\alias{$.multiPhylo}
+\alias{str.multiPhylo}
 \title{Compact Display of a Phylogeny}
 \usage{
 \method{print}{phylo}(x, printlen = 6 ,...)
 \method{print}{multiPhylo}(x, details = FALSE ,...)
 \method{[}{multiPhylo}(x, i)
+\method{[[}{multiPhylo}(x, i)
+\method{$}{multiPhylo}(x, name)
+\method{str}{multiPhylo}(object, ...)
 }
 \arguments{
   \item{x}{an object of class \code{"phylo"} or \code{"multiPhylo"}.}
+  \item{object}{an object of class \code{"multiPhylo"}.}
   \item{printlen}{the number of labels to print (6 by default).}
   \item{details}{a logical indicating whether to print information on
     all trees.}
-  \item{i}{indices of the trees to select from a list; this may be a
+  \item{i}{indices of the tree(s) to select from a list; this may be a
     vector of integers, logicals, or names.}
+  \item{name}{a character string specifying the tree to be extracted.}
   \item{...}{further arguments passed to or from other methods.}
 }
 \description{
   These functions prints a compact summary of a phylogeny, or a list of,
   on the console.
+
+  The operators \code{[}, \code{[[}, and \code{$} propagate the class
+  correctly.
 }
 \value{
-  An object of class \code{"multiPhylo"} or NULL.
+  An object of class \code{"phylo"} (\code{[[}, \code{$}) or of class
+  \code{"multiPhylo"} (\code{[[}), or NULL.
 }
 \author{Ben Bolker \email{bolker@zoo.ufl.edu} and Emmanuel Paradis
   \email{Emmanuel.Paradis@mpl.ird.fr}}