[Adephylo-commits] r12 - pkg/man

[noreply at r-forge.r-project.org]

Author: jombart
Date: 2008-11-20 19:59:22 +0100 (Thu, 20 Nov 2008)
New Revision: 12

Added:
   pkg/man/listNodes.Rd
Modified:
   pkg/man/listTips.Rd
Log:
Added doc for listNodes.


Added: pkg/man/listNodes.Rd
===================================================================
--- pkg/man/listNodes.Rd	                        (rev 0)
+++ pkg/man/listNodes.Rd	2008-11-20 18:59:22 UTC (rev 12)
@@ -0,0 +1,34 @@
+\name{listNodes}
+\alias{listNodes}
+\title{List direct descendants for all nodes of a tree}
+\description{
+  The function \code{listNodes} lists the direct descendants from each node
+  of a tree. The tree can be of class \code{\link[pkg:ape]{phylo}},
+  \linkS4class{phylo4} or \linkS4class{phylo4d}.
+}
+\usage{
+listNodes(x)
+}
+\arguments{
+  \item{x}{A tree of  class \code{\link[pkg:ape]{phylo}},
+    \linkS4class{phylo4} or \linkS4class{phylo4d}.}
+}
+\value{
+  A list whose components are vectors of named nodes (or tips) for a
+  given internal node.
+}
+\author{ Thibaut Jombart \email{jombart at biomserv.univ-lyon1.fr} }
+\seealso{\code{\link{listTips}} which lists the tips descending from
+  each node. \cr
+  
+  \code{\link{treePart}} which defines partitions of tips
+  according to the tree topology.}
+\examples{
+if(require(ape) & require(phylobase)){
+## make a tree
+x <- as(rtree(20),"phylo4")
+plot(x,show.node=TRUE)
+listNodes(x)
+}
+}
+\keyword{manip}

Modified: pkg/man/listTips.Rd
===================================================================
--- pkg/man/listTips.Rd	2008-11-20 18:55:44 UTC (rev 11)
+++ pkg/man/listTips.Rd	2008-11-20 18:59:22 UTC (rev 12)
@@ -17,7 +17,7 @@
   A list whose components are vectors of named tips for a given node.
 }
 \author{ Thibaut Jombart \email{jombart at biomserv.univ-lyon1.fr} }
-\seealso{\code{\link{treePart}} which lists the direct descendants for
+\seealso{\code{\link{treeNodes}} which lists the direct descendants for
   each node. \cr
   
   \code{\link{treePart}} which defines partitions of tips