[Depmix-commits] r328 - trunk/man

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

Author: ingmarvisser
Date: 2010-01-28 17:02:54 +0100 (Thu, 28 Jan 2010)
New Revision: 328

Modified:
   trunk/man/depmix.Rd
   trunk/man/depmixS4-package.Rd
   trunk/man/response-classes.Rd
Log:
minor changes in Rd files.

Modified: trunk/man/depmix.Rd
===================================================================
--- trunk/man/depmix.Rd	2010-01-28 16:02:21 UTC (rev 327)
+++ trunk/man/depmix.Rd	2010-01-28 16:02:54 UTC (rev 328)
@@ -78,20 +78,21 @@
 	which needs to be fitted using \code{\link{fit}} to optimize the
 	parameters.
 	
-	The response model(s) are created by call(s) to \code{\link{response}}
-	providing the response formula and the family specifying the error
-	distribution.  If response is a list of formulae, the \code{response}'s
-	are assumed to be independent conditional on the latent state.
+	The response model(s) are by default created by call(s) to 
+	\code{\link{GLMresponse}} providing the response formula and the 
+	family specifying the error distribution.  If response is a list of 
+	formulae, the \code{response}'s are assumed to be independent 
+	conditional on the latent state.
 	
 	The transitions are modeled as a multinomial logistic model for each
 	state.  Hence, the transition matrix can be modeled as time-dependent,
 	depending on predictors.  The prior density is also modeled as a
-	multinomial logistic.  Both are created by calls to
+	multinomial logistic.  Both of these models are created by calls to
 	\code{\link{transInit}}.
 	
 	Starting values may be provided by the respective arguments.  The order
 	in which parameters must be provided can be easily studied by using the
-	\code{\link{setpars}} function.
+	\code{\link{setpars}} and \code{\link{getpars}} functions.
 	
 	Linear constraints on parameters can be provided as argument to the
 	\code{\link{fit}} function.
@@ -137,6 +138,12 @@
 
 }
 
+\note{
+	Models are not fitted; the return value of \code{depmix} is a model
+	specification without optimized parameter values. Use the \code{\link{fit}}
+	function to optimize parameters, and to specify additional constraints.
+}
+
 \author{Ingmar Visser & Maarten Speekenbrink}
 
 \seealso{

Modified: trunk/man/depmixS4-package.Rd
===================================================================
--- trunk/man/depmixS4-package.Rd	2010-01-28 16:02:21 UTC (rev 327)
+++ trunk/man/depmixS4-package.Rd	2010-01-28 16:02:54 UTC (rev 328)
@@ -20,7 +20,8 @@
 	to be incorporated.  Models can be fitted on (multiple) sets of
 	observations.  The response densities for each state may be chosen from
 	the GLM family, or a multinomial.  User defined response densities are
-	easy to add.
+	easy to add; for the latter an example is given for the ex-gauss distribution
+	as well as the multivariate normal distribution. 
 	
 	Mixture or latent class (regression) models can also be fitted; these
 	are the limit case in which the length of observed time series is 1 for
@@ -33,8 +34,8 @@
 	\tabular{ll}{
 		Package: \tab depmixS4\cr
 		Type: \tab Package\cr
-		Version: \tab 0.2-2\cr
-		Date: \tab 2009-24-06\cr
+		Version: \tab 0.3-0\cr
+		Date: \tab 2010-01-30\cr
 		License: \tab GPL\cr
 	}
 
@@ -80,5 +81,9 @@
 }
 
 \examples{
-	# These should be added at some point ...
+	# create a 2 state model with one continuous and one binary response
+	data(speed)
+	mod <- depmix(list(rt~1,corr~1),data=speed,nstates=2,family=list(gaussian(),multinomial()))
+	# print the model, formulae and parameter values (ie the starting values)
+	mod
 }
\ No newline at end of file

Modified: trunk/man/response-classes.Rd
===================================================================
--- trunk/man/response-classes.Rd	2010-01-28 16:02:21 UTC (rev 327)
+++ trunk/man/response-classes.Rd	2010-01-28 16:02:54 UTC (rev 328)
@@ -24,8 +24,8 @@
 		\item{\code{formula}:}{A formula that specifies the model.}
 
 		\item{\code{family}:}{A family object specifying the link 
-		function. Currently, the only options are \code{gaussian()} from 
-		the \code{\link{stats}}-package and \code{multinomial}.}
+		function. See the \code{\link{response}} help page for 
+		possible options.}
 	}
 	
 }