[Adephylo-commits] r160 - pkg/man

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

Author: jombart
Date: 2010-03-14 21:02:16 +0100 (Sun, 14 Mar 2010)
New Revision: 160

Modified:
   pkg/man/distTips.Rd
Log:
small comment in the description.


Modified: pkg/man/distTips.Rd
===================================================================
--- pkg/man/distTips.Rd	2010-03-14 19:59:51 UTC (rev 159)
+++ pkg/man/distTips.Rd	2010-03-14 20:02:16 UTC (rev 160)
@@ -4,10 +4,15 @@
 \description{
   The function \code{distTips} computes a given distance between a set
   of tips of a phylogeny. A vector of tips is supplied: distances
-  between all possible pairs of these tips are computed.
-  The distances are computed from the shortest path
-  between the tips. Several distances can be used, defaulting to the
-  sum of branch lengths (see argument \code{method}).
+  between all possible pairs of these tips are computed.  The distances
+  are computed from the shortest path between the tips. Several
+  distances can be used, defaulting to the sum of branch lengths (see
+  argument \code{method}).
+
+  An option (enabled by default) allows computations to be run using
+  compiled C code, which is much faster than pure R code. In this case,
+  a matrix of all pairwise distances is returned (i.e., \code{tips}
+  argument is ignored).
 }
 \usage{
 distTips(x, tips, method=c("patristic","nNodes","Abouheif","sumDD"), useC=TRUE)