[Depmix-commits] r488 - in pkg/depmixS4: R man

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

Author: ingmarvisser
Date: 2011-09-01 17:16:58 +0200 (Thu, 01 Sep 2011)
New Revision: 488

Modified:
   pkg/depmixS4/R/fb.R
   pkg/depmixS4/man/forwardbackward.Rd
Log:
Added documentation for the useC argument in fb/forwardbackward and corrected the PACKAGE argument to the .C call.

Modified: pkg/depmixS4/R/fb.R
===================================================================
--- pkg/depmixS4/R/fb.R	2011-09-01 10:32:58 UTC (rev 487)
+++ pkg/depmixS4/R/fb.R	2011-09-01 15:16:58 UTC (rev 488)
@@ -64,7 +64,7 @@
  			beta=as.double(beta),
 			sca=as.double(sca),
 			xi=as.double(xi),
- 			package="depmixS4")[c("alpha","beta","sca","xi")]
+ 			PACKAGE="depmixS4")[c("alpha","beta","sca","xi")]
 		
 		alpha <- matrix(res$alpha,nc=ns,byrow=TRUE)
 		beta <- matrix(res$beta,nc=ns,byrow=TRUE)
Modified: pkg/depmixS4/man/forwardbackward.Rd
===================================================================
--- pkg/depmixS4/man/forwardbackward.Rd	2011-09-01 10:32:58 UTC (rev 487)
+++ pkg/depmixS4/man/forwardbackward.Rd	2011-09-01 15:16:58 UTC (rev 488)
@@ -2,6 +2,8 @@
 
 \alias{forwardbackward}
 
+\alias{forwardbackward,mix-method}
+
 \alias{forwardbackward,depmix-method}
 
 \title{ Forward and backward variables }
@@ -14,7 +16,7 @@
 
 \usage{
 
-	\S4method{forwardbackward}{depmix}(object, return.all=TRUE, ...)
+	\S4method{forwardbackward}{mix}(object, return.all=TRUE, useC=TRUE, ...)
 
 }
 
@@ -25,6 +27,10 @@
 	\item{return.all}{If FALSE, only gamma and xi and the log likelihood
 	are returned (which are the only variables needed in using EM).}
   	
+	\item{useC}{Flag used to set whether the C-code is used to compute the
+	forward, backward, gamma and xi variables or not; the R-code is basically
+	obsolete (but retained for now for debugging purposes).}
+	
 	\item{\dots}{Not currently used.}
 
 }