[Mattice-commits] r102 - pkg/man

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

Author: andrew_hipp
Date: 2008-12-22 18:01:17 +0100 (Mon, 22 Dec 2008)
New Revision: 102

Modified:
   pkg/man/summary.hansenBatch.Rd
Log:
added the print method to this documentation file

Modified: pkg/man/summary.hansenBatch.Rd
===================================================================
--- pkg/man/summary.hansenBatch.Rd	2008-12-22 16:51:34 UTC (rev 101)
+++ pkg/man/summary.hansenBatch.Rd	2008-12-22 17:01:17 UTC (rev 102)
@@ -1,24 +1,32 @@
 \name{summary.hansenBatch}
 \alias{summary.hansenBatch}
+\alias{print.hansenSummary}
 \title{Summarize output from runBatchHansen}
 \description{
   \code{summary.hansenBatch} is a summary method for a \code{hansenBatch} object.
+  \code{print.hansenSummary} is a print method for a \code{hansenSummary} object.
 }
 \usage{
 summary(hansenBatch)
+print(hansenSummary)
 }
 \arguments{
   \item{hansenBatch}{
   Output from \code{runBatchHansen}.
   }
+  \item{hansenSummary}{
+  Output from \code{summary.hansenBatch}.
+  }  
 }
 \details{
-    This function averages parameters over models and over trees, and provides the cumulative information-criterion weight
-    for models containing each node as an estimate of the support for the hypothesis that there was a character shift
-    at that node.
+    \code{summary.hansenBatch} averages parameters over models and over trees, and provides the cumulative 
+    information-criterion weight for models containing each node as an estimate of the support for the hypothesis 
+    that there was a character shift at that node.
+    \code{print.hansenSummary} provides an easy-to-read synopsis of the analysis summary. Called automatically when you simply type
+    in the name of the summary object.
 }
 \value{
-  A list of class \code{hansenSummary} with the following items:
+  For \code{summary.hansenBatch}, a list of class \code{hansenSummary} with the following items:
   \item{modelsMatrix}{
     A list of matrices, indexed by tree, providing the information criterion weights for each model.
   }
@@ -44,5 +52,5 @@
   }
 \author{Andrew Hipp <ahipp at mortonarb.org>}
 \seealso{
-   \code{\link{print.hansenSummary}} for a readable screen output summarizing most of the above; \code{\link{carex}} for an example
+   \code{\link{carex}} for an example
 }