[Pomp-commits] r514 - pkg/man

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

Author: kingaa
Date: 2011-06-07 10:23:04 +0200 (Tue, 07 Jun 2011)
New Revision: 514

Modified:
   pkg/man/dacca.Rd
   pkg/man/eulermultinom.Rd
Log:

- fix 'dacca.Rd' to eliminate codoc warning
- provide ascii-only eqns for 'eulermultinom' help


Modified: pkg/man/dacca.Rd
===================================================================
--- pkg/man/dacca.Rd	2011-06-06 14:32:23 UTC (rev 513)
+++ pkg/man/dacca.Rd	2011-06-07 08:23:04 UTC (rev 514)
@@ -6,13 +6,12 @@
 \description{
   \code{dacca} is a \code{pomp} object containing census and cholera mortality data from the Dacca district of the former British province of Bengal over the years 1891 to 1940 together with a stochastic differential equation transmission model.
   The model is that of King et al. (2008).
-  It also has the MLE for the SIRS model with seasonal reservoir.
+  The parameters are the MLE for the SIRS model with seasonal reservoir.
 
   Data are provided courtesy of Dr. Menno J. Bouma, London School of Tropical Medicine and Hygiene.
 }
 \usage{
 data(dacca)
-dacca.transform(params,dir=c("forward","inverse"))
 }
 \details{
   \code{dacca} is a \code{pomp} object containing the model, data, and MLE parameters.

Modified: pkg/man/eulermultinom.Rd
===================================================================
--- pkg/man/eulermultinom.Rd	2011-06-06 14:32:23 UTC (rev 513)
+++ pkg/man/eulermultinom.Rd	2011-06-07 08:23:04 UTC (rev 514)
@@ -19,23 +19,23 @@
   \item{log}{logical; if TRUE, return logarithm(s) of probabilities.}
 }
 \details{
-  If \eqn{N} individuals face constant hazards of death in \eqn{k} ways at rates \eqn{r_1, r_2, \dots, r_k}, then in an interval of duration \eqn{\Delta t}, the number of individuals remaining alive and dying in each way is multinomially distributed:
-  \deqn{(N-\sum_{i=1}^k \Delta n_i, \Delta n_1, \dots, \Delta n_k) \sim \mathrm{multinomial}(N;p_0,p_1,\dots,p_k),}
-  where \eqn{\Delta n_i} is the number of individuals dying in way \eqn{i} over the interval, the probability of remaining alive is \eqn{p_0=\exp(-\sum_i r_i \Delta t)}, and the probability of dying in way \eqn{j} is
-  \deqn{p_j=\frac{r_j}{\sum_i r_i} (1-\exp(-\sum_i r_i \Delta t)).}
+  If \eqn{N} individuals face constant hazards of death in \eqn{k} ways at rates \eqn{r_1, r_2, \dots, r_k}{r1,r2,\dots,rk}, then in an interval of duration \eqn{\Delta t}{dt}, the number of individuals remaining alive and dying in each way is multinomially distributed:
+  \deqn{(N-\sum_{i=1}^k \Delta n_i, \Delta n_1, \dots, \Delta n_k) \sim \mathrm{multinomial}(N;p_0,p_1,\dots,p_k),}{(N-\sum(dni), dn1, \dots, dnk) ~ multinomial(N;p0,p1,\dots,pk),}
+  where \eqn{\Delta n_i}{dni} is the number of individuals dying in way \eqn{i} over the interval, the probability of remaining alive is \eqn{p_0=\exp(-\sum_i r_i \Delta t)}{p0=exp(-\sum(ri dt))}, and the probability of dying in way \eqn{j} is
+  \deqn{p_j=\frac{r_j}{\sum_i r_i} (1-\exp(-\sum_i r_i \Delta t)).}{pj=(1-exp(-sum(ri dt))) rj/(\sum(ri)).}
   In this case, we can say that
-  \deqn{(\Delta n_1, \dots, \Delta n_k) \sim \mathrm{eulermultinom}(N,r,\Delta t),}
-  where \eqn{r=(r_1,\dots,r_k)}.
+  \deqn{(\Delta n_1, \dots, \Delta n_k) \sim \mathrm{eulermultinom}(N,r,\Delta t),}{(dn1,\dots,dnk)~eulermultinom(N,r,dt),}
+  where \eqn{r=(r_1,\dots,r_k)}{r=(r1,\dots,rk)}.
   Draw \eqn{m} random samples from this distribution by doing
   
   \code{reulermultinom(n=m,size=N,rate=r,dt=dt)},
 
   where \code{r} is the vector of rates.
-  Evaluate the probability that \eqn{x_1,\dots,x_k} are the numbers of individuals who have died in each of the \eqn{k} ways over the interval \eqn{\Delta t=}\code{dt}, by doing
+  Evaluate the probability that \eqn{x_1,\dots,x_k}{x1,\dots,xk} are the numbers of individuals who have died in each of the \eqn{k} ways over the interval \eqn{\Delta t=}{}\code{dt}, by doing
 
   \code{deulermultinom(x=x,size=N,rate=r,dt=dt)},
 
-  where \code{x} is a length \eqn{k} vector and \code{x[i]=}\eqn{x_i}.
+  where \code{x=c(x1,\dots,xk)}.
   
   Direct access to the underlying C routines is available: see the header file \dQuote{pomp.h}, included with the package.
 }