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

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

Author: jarioksa
Date: 2011-08-26 17:39:03 +0200 (Fri, 26 Aug 2011)
New Revision: 1761

Modified:
   pkg/vegan/man/ordihull.Rd
Log:
more visible documentation of summary.{ordihull,ordiellipse}

Modified: pkg/vegan/man/ordihull.Rd
===================================================================
--- pkg/vegan/man/ordihull.Rd	2011-08-25 13:45:34 UTC (rev 1760)
+++ pkg/vegan/man/ordihull.Rd	2011-08-26 15:39:03 UTC (rev 1761)
@@ -27,6 +27,8 @@
          show.groups, label = FALSE, ...)
 ordicluster(ord, cluster, prune = 0, display = "sites",
          w = weights(ord, display), ...)
+\method{summary}{ordihull}(object, ...)
+\method{summary}{ordiellipse}(object, ...)
 }
 
 \arguments{
@@ -75,6 +77,11 @@
     dendrogram. If \code{prune} \eqn{>0}, dendrogram will be
     disconnected.}
 
+  \item{object}{A result object from \code{ordihull} or
+    \code{ordiellipse}. The result is \code{\link{invisible}}, but it
+    can be saved, and used for summaries (areas etc. of hulls and
+    ellipses). }
+
   \item{\dots}{Parameters passed to graphical functions or to
     \code{\link{scores}} to select axes and scaling etc. } 
 }