[Vegan-commits] r208 - branches/1.11-0/man pkg/man

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

Author: gsimpson
Date: 2008-02-15 17:36:07 +0100 (Fri, 15 Feb 2008)
New Revision: 208

Modified:
   branches/1.11-0/man/permCheck.Rd
   pkg/man/permCheck.Rd
Log:
Added Note section to permCheck.Rd

Modified: branches/1.11-0/man/permCheck.Rd
===================================================================
--- branches/1.11-0/man/permCheck.Rd	2008-02-15 16:08:17 UTC (rev 207)
+++ branches/1.11-0/man/permCheck.Rd	2008-02-15 16:36:07 UTC (rev 208)
@@ -79,6 +79,17 @@
 }
 %\references{
 %}
+\note{
+  Currently, complete enumeration is not implemented in
+  \code{\link{permuted.index2}}. \code{permCheck} sets complete
+  enumeration in the \code{'control'} component of the returned object
+  but this is not acted upon in the permutations.
+
+  \code{permCheck} does reduce the \code{'nperm'} and \code{'maxperm'}
+  components of the returned object to the maximum number of possible
+  permutations, and \code{\link{permuted.index2}} obeys these
+  directives.
+}
 \author{Gavin Simpson}
 \seealso{\code{\link{permCheck}}.}
 

Modified: pkg/man/permCheck.Rd
===================================================================
--- pkg/man/permCheck.Rd	2008-02-15 16:08:17 UTC (rev 207)
+++ pkg/man/permCheck.Rd	2008-02-15 16:36:07 UTC (rev 208)
@@ -79,6 +79,17 @@
 }
 %\references{
 %}
+\note{
+  Currently, complete enumeration is not implemented in
+  \code{\link{permuted.index2}}. \code{permCheck} sets complete
+  enumeration in the \code{'control'} component of the returned object
+  but this is not acted upon in the permutations.
+
+  \code{permCheck} does reduce the \code{'nperm'} and \code{'maxperm'}
+  components of the returned object to the maximum number of possible
+  permutations, and \code{\link{permuted.index2}} obeys these
+  directives.
+}
 \author{Gavin Simpson}
 \seealso{\code{\link{permCheck}}.}