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

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

Author: jarioksa
Date: 2010-03-04 16:39:52 +0100 (Thu, 04 Mar 2010)
New Revision: 1165

Modified:
   pkg/vegan/inst/ChangeLog
   pkg/vegan/man/ordistep.Rd
Log:
documented rev1131: 'anova' component in the ordistep result

Modified: pkg/vegan/inst/ChangeLog
===================================================================
--- pkg/vegan/inst/ChangeLog	2010-03-03 11:52:24 UTC (rev 1164)
+++ pkg/vegan/inst/ChangeLog	2010-03-04 15:39:52 UTC (rev 1165)
@@ -4,6 +4,9 @@
 
 Version 1.18-2 (opened February 18, 2010)
 
+	* ordistep: documented the 'anova' component added to the result
+	object. 
+
 	* densityplot.oecosimu: gives no warning if there is only one
 	statistic and hence only one panel.
 

Modified: pkg/vegan/man/ordistep.Rd
===================================================================
--- pkg/vegan/man/ordistep.Rd	2010-03-03 11:52:24 UTC (rev 1164)
+++ pkg/vegan/man/ordistep.Rd	2010-03-04 15:39:52 UTC (rev 1165)
@@ -57,7 +57,7 @@
 \details{
   The basic functions for model choice in constrained ordination are
   \code{\link{add1.cca}} and \code{\link{drop1.cca}}. With these functions,
-  ordination models can be chosen with standard \R\ function 
+  ordination models can be chosen with standard \R function 
   \code{\link{step}} which bases the term choice on AIC. AIC-like 
   statistics for ordination are provided by functions 
   \code{\link{deviance.cca}} and \code{\link{extractAIC.cca}} (with 
@@ -76,8 +76,13 @@
   is often sensible to have \code{Pout} \eqn{>} \code{Pin} in stepwise
   models to avoid cyclic adds and drops of single terms. 
 }
-\value{
-  Function returns the chosen model.
+
+\value{ 
+  Function returns the selected model with one additional
+  component, \code{anova}, which contains brief information of steps
+  taken. You can suppress voluminous output during model building by
+  setting \code{trace = FALSE}, and find the summary of model history
+  in the \code{anova} item.  
 }
 
 \author{