[Pomp-commits] r513 - pkg/man

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

Author: kingaa
Date: 2011-06-06 16:32:23 +0200 (Mon, 06 Jun 2011)
New Revision: 513

Modified:
   pkg/man/gompertz.Rd
Log:

- fix Gompertz model documentation


Modified: pkg/man/gompertz.Rd
===================================================================
--- pkg/man/gompertz.Rd	2011-06-06 14:20:13 UTC (rev 512)
+++ pkg/man/gompertz.Rd	2011-06-06 14:32:23 UTC (rev 513)
@@ -1,19 +1,23 @@
 \name{gompertz}
 \alias{gompertz}
 \docType{data}
-\title{Gompertz model with normal observations.}
+\title{Gompertz model with log-normal observations.}
 \description{
-  \code{gompertz} is a \code{pomp} object encoding a stochastic Gompertz population model with normal measurement error.
+  \code{gompertz} is a \code{pomp} object encoding a stochastic Gompertz population model with log-normal measurement error.
 }
 \usage{data(gompertz)}
 \details{
-  The state process is \eqn{X_{t+1} = K^{(1-R)} X_{t}^R \varepsilon_{t}}, where the \eqn{\varepsilon_t} are i.i.d. lognormal random deviates with variance \eqn{\sigma^2}.
-  The observed variables \eqn{Y_t} are distributed as \eqn{\mathrm{normal}(X_t,\tau)}.
+  The state process is \eqn{X_{t+1} = K^{(1-S)} X_{t}^S \varepsilon_{t}}, where \eqn{S=e^{-r}} and the \eqn{\varepsilon_t} are i.i.d. lognormal random deviates with variance \eqn{\sigma^2}.
+  The observed variables \eqn{Y_t} are distributed as \eqn{\mathrm{lognormal}(\log{X_t},\tau)}.
+  The model is parameterized by the logarithms of \eqn{r}, \eqn{K}, \eqn{\sigma}, and \eqn{\tau};
+  the initial condition is parameterized directly.
 }
 \examples{
 data(gompertz)
 plot(gompertz)
 coef(gompertz)
 }
-\seealso{\code{\link{pomp-class}} and the vignettes}
+\seealso{
+  \code{\link{pomp-class}} and the introductory vignette \code{vignette("intro_to_pomp")}.
+}
 \keyword{datasets}