[Depmix-commits] r383 - trunk/man

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

Author: ingmarvisser
Date: 2010-03-05 14:10:59 +0100 (Fri, 05 Mar 2010)
New Revision: 383

Modified:
   trunk/man/depmix.fit.Rd
Log:
Added documentation for which argument to summaries of models such that summaries can be limited to submodels.

Modified: trunk/man/depmix.fit.Rd
===================================================================
--- trunk/man/depmix.fit.Rd	2010-03-04 23:03:06 UTC (rev 382)
+++ trunk/man/depmix.fit.Rd	2010-03-05 13:10:59 UTC (rev 383)
@@ -31,13 +31,13 @@
 		conrows.upper=0, conrows.lower=0, method=NULL,tol=1e-8,
 		crit=c("relative","absolute"),verbose=TRUE,...)
 	
-	\S4method{summary}{depmix.fitted}(object)
+	\S4method{summary}{depmix.fitted}(object,which="all")
 
 	\S4method{fit}{mix}(object, fixed=NULL, equal=NULL, conrows=NULL,
 		conrows.upper=0, conrows.lower=0, method=NULL,tol=1e-8,
 		crit=c("relative","absolute"),verbose=TRUE,...)
 	
-	\S4method{summary}{mix.fitted}(object)
+	\S4method{summary}{mix.fitted}(object,which="all")
 
 	
 }
@@ -59,12 +59,15 @@
 	\item{method}{The optimization method; mostly determined by
 		constraints.}
 		
-  \item{tol}{The tolerance level for convergence.}
+	\item{tol}{The tolerance level for convergence.}
   
-  \item{crit}{The convergence criterion in the EM algorithm; either the relative
-  change in the log likelihood, or the absolute change in the log-likelihood.}
+	\item{crit}{The convergence criterion in the EM algorithm; either the relative
+  		change in the log likelihood, or the absolute change in the log-likelihood.}
   
-  \item{verbose}{Should optimization information be displayed on screen?}
+	\item{verbose}{Should optimization information be displayed on screen?}
+	
+	\item{which}{Should summaries be provided for "all" submodels? Options 
+		are "prior", "response", and for fitted depmix models also "transition".}
   
 	\item{...}{Further arguments passed on to the optimization methods.}