]> git.donarmstrong.com Git - ape.git/blobdiff - man/subtrees.Rd
various corrections
[ape.git] / man / subtrees.Rd
index b59d70987844c2c4e284de9bf5d47333b5e6d7b4..bc171a865cd89d61b650f7978c0727176b977165 100644 (file)
@@ -2,27 +2,28 @@
 \alias{subtrees}
 \title{All subtrees of a Phylogenetic Tree}
 \usage{
-subtrees(x, wait=FALSE)
+subtrees(tree, wait=FALSE)
 }
 \arguments{
-  \item{x}{an object of class \code{"phylo"}.}
+  \item{tree}{an object of class \code{"phylo"}.}
   \item{wait}{a logical indicating whether the node beeing processed should be printed (useful for big phylogenies).}
 }
 \description{
   This function returns a list of all the subtrees of a phylogenetic tree.
 }
 \author{Damien de Vienne \email{damien.de-vienne@u-psud.fr}}
-\see also{
+\seealso{
   \code{\link{zoom}}, \code{\link{subtreeplot}} for functions extracting particular subtrees.
 }
 \value{
-  \code{subtrees} returns a list of trees of class \code{"phylo"} and returns invisibly for each subtree a list with the following
+  \code{subtrees} returns a list of trees of class \code{"phylo"} and
+  returns invisibly for each subtree a list with the following
   components:
 
-  \item{tip.label}
-  \item{node.label}
-  \item{Ntip}
-  \item{Nnode}
+  \item{tip.label}{}
+  \item{node.label}{}
+  \item{Ntip}{}
+  \item{Nnode}{}
 }
 \examples{
 ### Random tree with 12 leaves
@@ -37,3 +38,4 @@ l<-subtrees(phy)
 for (i in 1:11) plot(l[[i]], sub=paste("Node", l[[i]]$node.label[1]))
 par(mfrow=c(1,1))
 }
+\keyword{manip}