[Phylobase-commits] r431 - pkg/man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Sun Apr 26 06:38:18 CEST 2009
Author: pdc
Date: 2009-04-26 06:38:17 +0200 (Sun, 26 Apr 2009)
New Revision: 431
Modified:
pkg/man/treewalk.Rd
Log:
Remove errant \item and tidy
Modified: pkg/man/treewalk.Rd
===================================================================
--- pkg/man/treewalk.Rd 2009-04-22 15:42:53 UTC (rev 430)
+++ pkg/man/treewalk.Rd 2009-04-26 04:38:17 UTC (rev 431)
@@ -48,28 +48,25 @@
in the tree: warn, do nothing, or stop with an error}
}
\value{
- \item{\code{getNode}}{takes character strings corresponding to tip
- or node labels, or node numbers; it returns a named
+ \item{\code{getNode}}{
+ takes character strings corresponding to tip or node labels, or node numbers; it returns a named
vector of node numbers}
- \item{\code{getEdge}}{takes character strings naming terminal
- node of edges, or the corresponding node numbers; it returns a named
- vector of edge numbers.}
+ \item{\code{getEdge}}{
+ takes character strings naming terminal node of edges, or the corresponding node numbers; it
+ returns a named vector of edge numbers}
\item{\code{ancestors} and \code{descendants}}{
- return named vectors of the ancestors and descendants of
- a node; \code{ancestor} is a synonym for
- \item \code{ancestors(\dots,which="parent")} (i.e. direct
- ancestor only), while
- \code{children} is a synonym for
- \code{descendants(\dots,which="children")} (i.e. direct
- descendants only)}
- \item{\code{siblings}}{returns sibling nodes (children
- of the same parent)}
- \item{\code{mrca}}{returns the most recent common ancestor of two or
- more nodes}
- \item{\code{shortestPath}}{returns the nodes of the shortest path from one
- node to another (excluding \code{node1} and \code{node2})}
- \item{\code{sumEdgeLength}}{returns the sum of branch length for branches
- starting at nodes provided.}
+ return named vectors of the ancestors and descendants of a node; \code{ancestor} is a synonym
+ for \code{ancestors(\dots, which="parent")} (i.e. direct ancestor only), while \code{children}
+ is a synonym for \code{descendants(\dots, which="children")} (i.e. direct descendants only)}
+ \item{\code{siblings}}{
+ returns sibling nodes (children of the same parent)}
+ \item{\code{mrca}}{
+ returns the most recent common ancestor of two or more nodes}
+ \item{\code{shortestPath}}{
+ returns the nodes of the shortest path from one node to another (excluding \code{node1} and
+ \code{node2})}
+ \item{\code{sumEdgeLength}}{
+ returns the sum of branch length for branches starting at nodes provided}
}
\note{\code{MRCA} is uppercase to avoid conflict with \code{mrca}
in ape}
More information about the Phylobase-commits
mailing list