[Vegan-commits] r753 - in pkg/vegan: inst man

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

Author: jarioksa
Date: 2009-03-22 18:13:47 +0100 (Sun, 22 Mar 2009)
New Revision: 753

Modified:
   pkg/vegan/inst/ChangeLog
   pkg/vegan/man/envfit.Rd
Log:
help page of envfit explains the automatic scaling of arrows to plot dimensions

Modified: pkg/vegan/inst/ChangeLog
===================================================================
--- pkg/vegan/inst/ChangeLog	2009-03-22 07:11:03 UTC (rev 752)
+++ pkg/vegan/inst/ChangeLog	2009-03-22 17:13:47 UTC (rev 753)
@@ -4,6 +4,9 @@
 
 Version 1.16-15 (opened Mar 10, 2009)
 
+	* envfit help page: explains the automatic scaling and 'arrow.mul'
+	argument. 
+
 	* add1/drop1 help: better example after a query of usage in R
 	mailing list. 
 

Modified: pkg/vegan/man/envfit.Rd
===================================================================
--- pkg/vegan/man/envfit.Rd	2009-03-22 07:11:03 UTC (rev 752)
+++ pkg/vegan/man/envfit.Rd	2009-03-22 17:13:47 UTC (rev 753)
@@ -105,6 +105,12 @@
   similarity between fitted vectors and biplot arrows, you should set
   \code{display = "lc"} (and possibly \code{scaling = 2}).
 
+  The lengths of arrows for fitted vectors are automatically adjusted
+  for the physical size of the plot, and the arrow lengths cannot be
+  compared across plots. For similar scaling of arrows, you must
+  explicitly set the \code{arrow.mul} argument in the \code{plot}
+  command.
+
   The results can be accessed with \code{scores.envfit} function which
   returns either the fitted vectors scaled by correlation coefficient or
   the centroids of the fitted environmental variables.