[Vegan-commits] r2186 - pkg/vegan/man

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

Author: jarioksa
Date: 2012-05-24 20:49:05 +0200 (Thu, 24 May 2012)
New Revision: 2186

Modified:
   pkg/vegan/man/metaMDS.Rd
   pkg/vegan/man/monoMDS.Rd
Log:
mono/metaMDS Rd also tell about upper limits to the no. of dimensions

Modified: pkg/vegan/man/metaMDS.Rd
===================================================================
--- pkg/vegan/man/metaMDS.Rd	2012-05-24 18:38:47 UTC (rev 2185)
+++ pkg/vegan/man/metaMDS.Rd	2012-05-24 18:49:05 UTC (rev 2186)
@@ -54,7 +54,8 @@
     In the latter case all other stages are skipped except random 
     starts and centring and pc rotation of axes. }
   \item{distance}{Dissimilarity index used in \code{\link{vegdist}}.}
-  \item{k}{Number of dimensions in \code{\link[MASS]{isoMDS}}.}
+  \item{k}{Number of dimensions.  NB., the number of points \eqn{n}
+    should be \eqn{n > 2k + 1}{n > 2*k + 1}, and preferably higher.}
   \item{trymax}{Maximum number of random starts in search of stable
     solution.}
 

Modified: pkg/vegan/man/monoMDS.Rd
===================================================================
--- pkg/vegan/man/monoMDS.Rd	2012-05-24 18:38:47 UTC (rev 2185)
+++ pkg/vegan/man/monoMDS.Rd	2012-05-24 18:49:05 UTC (rev 2186)
@@ -26,7 +26,9 @@
   \item{dist}{Input dissimilarities.}
   \item{y}{Starting configuration. A random configuration will be
     generated if this is missing.}
-  \item{k}{Number of dimensions.}
+  
+  \item{k}{Number of dimensions. NB., the number of points \eqn{n}
+    should be \eqn{n > 2k + 1}{n > 2*k + 1}, and preferably higher.}
 
   \item{model}{MDS model: \code{"global"} is normal non-metric MDS
     with a monotone regression, \code{"local"} is non-metric MDS with