[Vegan-commits] r661 - in branches/1.15: inst man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Thu Jan 15 09:39:10 CET 2009
Author: jarioksa
Date: 2009-01-15 09:39:10 +0100 (Thu, 15 Jan 2009)
New Revision: 661
Modified:
branches/1.15/inst/ChangeLog
branches/1.15/man/cascadeKM.Rd
branches/1.15/man/cca.object.Rd
branches/1.15/man/mso.Rd
branches/1.15/man/vegdist.Rd
Log:
merged r660 in branches/1.15 (Rd parser 2 fixes)
Modified: branches/1.15/inst/ChangeLog
===================================================================
--- branches/1.15/inst/ChangeLog 2009-01-15 08:33:14 UTC (rev 660)
+++ branches/1.15/inst/ChangeLog 2009-01-15 08:39:10 UTC (rev 661)
@@ -5,6 +5,8 @@
Version 1.15-2 (opened January 14, 2009)
+ * merged r660: Rd parser v2 fixes to make vegan R 2.9.0-ready.
+
* merged r652, r657: cleaner output of summary.cca in unconstrained
models (PCA, CA).
Modified: branches/1.15/man/cascadeKM.Rd
===================================================================
--- branches/1.15/man/cascadeKM.Rd 2009-01-15 08:33:14 UTC (rev 660)
+++ branches/1.15/man/cascadeKM.Rd 2009-01-15 08:39:10 UTC (rev 661)
@@ -75,18 +75,18 @@
literally when the groups are not equal in size. Type \code{"all"} to
obtain both indices. The indices are defined as:
\describe{
- \item \bold{calinski}:
+ \item{calinski:}{
\eqn{(SSB/(K-1))/(SSW/(n-K))}, where \eqn{n} is the
number of data points and \eqn{K} is the number of clusters.
\eqn{SSW} is the sum of squares within the clusters while
\eqn{SSB} is the sum of squares among the clusters. This index
- is simply an \eqn{F} (ANOVA) statistic.
+ is simply an \eqn{F} (ANOVA) statistic.}
- \item \bold{ssi}:
+ \item{ssi:}{
the \dQuote{Simple Structure Index} multiplicatively combines
several elements which influence the interpretability of a
partitioning solution. The best partition is indicated by the
- highest SSI value.
+ highest SSI value.}
}
In a simulation study, Milligan and Cooper (1985) found
Modified: branches/1.15/man/cca.object.Rd
===================================================================
--- branches/1.15/man/cca.object.Rd 2009-01-15 08:33:14 UTC (rev 660)
+++ branches/1.15/man/cca.object.Rd 2009-01-15 08:39:10 UTC (rev 661)
@@ -42,12 +42,13 @@
component.
Items \code{pCCA}, \code{CCA} and \code{CA} have similar
structure, and contain following items:
+ \describe{
\item{\code{alias}}{The names of the aliased constraints or conditions.
Function \code{\link{alias.cca}} does not access this item
directly, but it finds the aliased variables and their defining
equations from the \code{QR} item.}
\item{\code{biplot}}{Biplot scores of constraints. Only in \code{CCA}.}
- \item{centroids}{(Weighted) centroids of factor levels of
+ \item{\code{centroids}}{(Weighted) centroids of factor levels of
constraints. Only in \code{CCA}. Missing if the ordination was not
called with \code{formula}.}
\item{\code{eig}}{Eigenvalues of axes. In \code{CCA} and \code{CA}.}
@@ -104,7 +105,7 @@
after both \code{pCCA} and \code{CCA}. In \code{\link{cca}} the
standardization is Chi-square, and in \code{\link{rda}} centring
and optional scaling by species standard deviations using function
- \code{\link{scale}}. }
+ \code{\link{scale}}.} }
}
}
Modified: branches/1.15/man/mso.Rd
===================================================================
--- branches/1.15/man/mso.Rd 2009-01-15 08:33:14 UTC (rev 660)
+++ branches/1.15/man/mso.Rd 2009-01-15 08:39:10 UTC (rev 661)
@@ -59,8 +59,8 @@
\value{
The function \code{mso} returns an amended \code{cca} or \code{rda}
object with the additional attributes \code{grain}, \code{H},
- \code{H.test} and \code{vario}.
- \item{grain }{ The grain attribute defines the interval size of the
+ \code{H.test} and \code{vario}.
+ \item{grain}{The grain attribute defines the interval size of the
distance classes .}
\item{H }{ H is an object of class 'dist' and contains the geographic
distances between observations.}
@@ -69,27 +69,30 @@
which distance class (columns). }
\item{vario }{ The vario attribute is a data frame that contains some
or all of the following components for the rda case (cca case in
- brackets):
- \item{H }{ Distance class as multiples of grain.}
- \item{Dist }{ Average distance of pairs of observations in distance class H.}
- \item{n }{ Number of unique pairs of observations in distance class
- H.}
- \item{All }{ Empirical (chi-square) variogram of total variance
- (inertia).}
- \item{Sum }{ Sum of empirical (chi-square) variograms of explained
- and residual variance (inertia).}
- \item{CA }{ Empirical (chi-square) variogram of residual variance
- (inertia).}
- \item{CCA }{ Empirical (chi-square) variogram of explained variance
- (inertia).}
- \item{pCCA }{ Empirical (chi-square) variogram of conditioned
- variance (inertia).}
- \item{se }{ Standard error of the empirical (chi-square) variogram
- of total variance (inertia).}
- \item{CA.signif }{P-value of permutation test for spatial
- independence of residual variance (inertia).}
+ brackets):
+ \describe{
+ \item{\code{H}}{Distance class as multiples of grain.}
+ \item{\code{Dist}}{ Average distance of pairs of observations in distance class H.}
+ \item{n }{ Number of unique pairs of observations in distance class
+ H.}
+ \item{\code{All}}{ Empirical (chi-square) variogram of total variance
+ (inertia).}
+ \item{\code{Sum}}{ Sum of empirical (chi-square) variograms of explained
+ and residual variance (inertia).}
+ \item{\code{CA}}{ Empirical (chi-square) variogram of residual variance
+ (inertia).}
+ \item{\code{CCA}}{ Empirical (chi-square) variogram of explained variance
+ (inertia).}
+ \item{\code{pCCA}}{ Empirical (chi-square) variogram of conditioned
+ variance (inertia).}
+ \item{\code{se}}{ Standard error of the empirical (chi-square) variogram
+ of total variance (inertia).}
+ \item{\code{CA.signif}}{P-value of permutation test for spatial
+ independence of residual variance (inertia).}
+ }
}
}
+
\references{ Wagner, H.H. 2004. Direct multi-scale ordination with
canonical correspondence analysis. \emph{Ecology} 85: 342--351. }
\author{ The responsible author was Helene Wagner.}
Modified: branches/1.15/man/vegdist.Rd
===================================================================
--- branches/1.15/man/vegdist.Rd 2009-01-15 08:33:14 UTC (rev 660)
+++ branches/1.15/man/vegdist.Rd 2009-01-15 08:39:10 UTC (rev 661)
@@ -73,10 +73,10 @@
min(x[ij],x[ik])/(sum x[ik]))}
\cr
\code{morisita}
- \tab {\eqn{d_{jk} = \frac{2 \sum_i x_{ij} x_{ik}}{(\lambda_j +
+ \tab \eqn{d_{jk} = \frac{2 \sum_i x_{ij} x_{ik}}{(\lambda_j +
\lambda_k) \sum_i x_{ij} \sum_i
x_{ik}}}{d[jk] = 2*sum(x[ij]*x[ik])/((lambda[j]+lambda[k]) *
- sum(x[ij])*sum(x[ik]))} }
+ sum(x[ij])*sum(x[ik]))}
\cr
\tab where \eqn{\lambda_j = \frac{\sum_i x_{ij} (x_{ij} - 1)}{\sum_i
x_{ij} \sum_i (x_{ij} - 1)}}{lambda[j] =
More information about the Vegan-commits
mailing list