[Depmix-commits] r150 - trunk/man

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

Author: ingmarvisser
Date: 2008-06-10 16:17:13 +0200 (Tue, 10 Jun 2008)
New Revision: 150

Modified:
   trunk/man/depmix-methods.Rd
   trunk/man/posterior.Rd
Log:
Minor changes in documentation

Modified: trunk/man/depmix-methods.Rd
===================================================================
--- trunk/man/depmix-methods.Rd	2008-06-10 14:09:26 UTC (rev 149)
+++ trunk/man/depmix-methods.Rd	2008-06-10 14:17:13 UTC (rev 150)
@@ -20,25 +20,38 @@
 \alias{getpars}
 \alias{getpars,depmix-method}
 
-\title{ The log likelihood. }
+\title{ Depmix methods. }
+
 \description{
 Computes the log likelihood of a depmix object.
 }
+
 \usage{
-	\S4method{logLik}{depmix}(object)
+	\S4method{logLik}{depmix}(object,method="lystig")
 
-	\S4method{nobs}{depmix}(object)
+	\S4method{nobs}{depmix}(object, ...)
 	
 	\S4method{npar}{depmix}(object)
 	\S4method{freepars}{depmix}(object)
-	\S4method{setpars}{depmix}(object,which="pars",...)
+	\S4method{setpars}{depmix}(object,values, which="pars",...)
 	\S4method{getpars}{depmix}(object,which="pars",...)	
 
 }
 %- maybe also 'usage' for other objects documented here.
 \arguments{
+
   \item{object}{A \code{depmix} pobject}
-
+  
+  \item{method}{The log likelihood can be computed by either the forward
+  backward algorithm from Rabiner, 1989, or by the method of Lystig &
+  Hughes, 2002.  The latter is the default as it is faster because in the
+  forward backward routine the state and transition smoothed probabilities
+  are also computed which are not neccessary for the log likelihood. Those
+  smoothed variables, and the forward and backward variables are accessible
+  through the \code{forwardbackward} function.}
+  
+  \item{values}{To be used in \code{setpars} to set new parameter values.}
+  
   \item{which}{The default "pars" returns a vector of all parameters of a
 	  \code{depmix} object; the alternative value "fixed" return a
 	  logical vector of the same length indicating which parameters are

Modified: trunk/man/posterior.Rd
===================================================================
--- trunk/man/posterior.Rd	2008-06-10 14:09:26 UTC (rev 149)
+++ trunk/man/posterior.Rd	2008-06-10 14:17:13 UTC (rev 150)
@@ -14,7 +14,7 @@
 }
 
 \usage{
-	\S4method{posterior}{depmix.fitted}(object,...)
+	\S4method{posterior}{depmix.fitted}(object)
 }
 
 \arguments{