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

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

Author: gsimpson
Date: 2011-06-29 10:43:47 +0200 (Wed, 29 Jun 2011)
New Revision: 1665

Modified:
   pkg/permute/man/shuffle-utils.Rd
Log:
updated documentation, fixes a NOTE under R CMD check

Modified: pkg/permute/man/shuffle-utils.Rd
===================================================================
--- pkg/permute/man/shuffle-utils.Rd	2011-06-29 07:29:08 UTC (rev 1664)
+++ pkg/permute/man/shuffle-utils.Rd	2011-06-29 08:43:47 UTC (rev 1665)
@@ -5,7 +5,7 @@
 \alias{shuffleSeries}
 \alias{shuffleStrata}
 
-\title{Utility functions for Unrestricted and restricted permutations}
+\title{Utility functions for unrestricted and restricted permutations}
 \description{
   Unrestricted and restricted permutations for time series,
   line transects, spatial grids and blocking factors.
@@ -43,8 +43,22 @@
     \code{"series"}.}
 }
 \details{
+  These are developer-level functions for generating permuted indexes
+  from one of several restricted and unrestricted designs.
+
+  \code{shuffleFree} is a wrapper to code underlying
+  \code{\link{sample}}, but without the extra over head of sanity
+  checks. It is defined as \code{.Internal(sample(x, size, FALSE,
+  NULL))}. You must arrange for the correct values to be supplied, where
+  \code{x} is a vector of indices to sample from, and \code{size} is the
+  number of indices to sample. Sampling is done without replacement and
+  without regard to prior probabilities. Argument \code{size} is allowed
+  so that one can draw a single observation at random from the indices
+  \code{x}. In general use, \code{size} would be set equal to
+  \code{length{x}}.
 }
 \value{
+  A integer vector of permuted indices.
 }
 %\note{
 %  \code{shuffle} is currently used in one Vegan function;