[adegenet-commits] r822 - pkg/man

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

Author: jombart
Date: 2011-02-24 16:32:20 +0100 (Thu, 24 Feb 2011)
New Revision: 822

Modified:
   pkg/man/glAux.Rd
Log:
Documented the new arg in glSum


Modified: pkg/man/glAux.Rd
===================================================================
--- pkg/man/glAux.Rd	2011-02-24 15:29:50 UTC (rev 821)
+++ pkg/man/glAux.Rd	2011-02-24 15:32:20 UTC (rev 822)
@@ -22,7 +22,7 @@
   - \code{glVar}: computes the variance of the number of second allele in each SNP.
 }
 \usage{
-glSum(x, alleleAsUnit = TRUE)
+glSum(x, alleleAsUnit = TRUE, useC = FALSE)
 glNA(x, alleleAsUnit = TRUE)
 glMean(x, alleleAsUnit = TRUE)
 glVar(x, alleleAsUnit = TRUE)
@@ -33,6 +33,10 @@
     considered as units (i.e., a diploid genotype equals two samples, a
     triploid, three, etc.) or whether individuals are considered as
     units of information.}
+  \item{useC}{a logical indicating whether compiled C code should be
+    used (TRUE) or not (FALSE, default). Pure-R code is more efficient
+    for small number of individuals; C-code is expected to be more
+    efficient for thousands of individuals.}
 }
 \details{
   === On the unit of information ===