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

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

Author: jarioksa
Date: 2009-06-12 07:47:52 +0200 (Fri, 12 Jun 2009)
New Revision: 868

Modified:
   pkg/vegan/man/cca.object.Rd
Log:
Document items capscale adds on negative eigenvalues to cca.object

Modified: pkg/vegan/man/cca.object.Rd
===================================================================
--- pkg/vegan/man/cca.object.Rd	2009-06-12 05:37:07 UTC (rev 867)
+++ pkg/vegan/man/cca.object.Rd	2009-06-12 05:47:52 UTC (rev 868)
@@ -76,6 +76,10 @@
      \code{CCA} components. Only in \code{CCA}.}
     \item{\code{tot.chi}}{Total inertia or the sum of all eigenvalues of the
       component.}
+    \item{\code{imaginary.chi}, \code{imaginary.rank}}{The sum and
+     rank (number) of negative eigenvalues in
+     \code{\link{capscale}}. Only in \code{CA} and only if negative
+     eigenvalues were found in \code{\link{capscale}}.}
     \item{\code{u}}{(Weighted) orthonormal site scores.  Please note that
       scaled scores are not stored in the \code{cca} object, but they
       are made when the object is accessed with functions like