[Vegan-commits] r2525 - pkg/permute/man

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

Author: gsimpson
Date: 2013-06-12 22:13:59 +0200 (Wed, 12 Jun 2013)
New Revision: 2525

Modified:
   pkg/permute/man/check.Rd
Log:
document new argument observed

Modified: pkg/permute/man/check.Rd
===================================================================
--- pkg/permute/man/check.Rd	2013-06-12 20:13:19 UTC (rev 2524)
+++ pkg/permute/man/check.Rd	2013-06-12 20:13:59 UTC (rev 2525)
@@ -12,7 +12,7 @@
   selected permutation design.
 }
 \usage{
-check(object, control = how(), make.all = TRUE)
+check(object, control = how(), make.all = TRUE, observed = FALSE)
 
 \method{summary}{check}(object, \dots)
 
@@ -33,6 +33,8 @@
   \item{make.all}{logical; should \code{permCheck} generate all
     possible permutations? Useful if want to check permutation design
     but not produce the matrix of all permutations.}
+  \item{observed}{logical; if making all possible permutations, should
+    the set include the observed permutation too?}
   \item{n}{the number of observations or an 'object' from which the
     number of observations can be determined via \code{getNumObs}.}
   \item{col, xlim, ylim, main, sub, ann, cex}{Graphical parameters.}