[Pomp-commits] r133 - in pkg: . man

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

Author: kingaa
Date: 2009-05-26 11:15:40 +0200 (Tue, 26 May 2009)
New Revision: 133

Modified:
   pkg/DESCRIPTION
   pkg/man/pomp-package.Rd
   pkg/man/pomp.Rd
Log:
clarify some documentation

Modified: pkg/DESCRIPTION
===================================================================
--- pkg/DESCRIPTION	2009-05-21 03:09:36 UTC (rev 132)
+++ pkg/DESCRIPTION	2009-05-26 09:15:40 UTC (rev 133)
@@ -1,8 +1,8 @@
 Package: pomp
 Type: Package
 Title: Statistical inference for partially observed Markov processes
-Version: 0.24-1
-Date: 2009-05-13
+Version: 0.24-2
+Date: 2009-05-26
 Author: Aaron A. King, Edward L. Ionides, Carles Martinez Breto, Steve Ellner, Bruce Kendall
 Maintainer: Aaron A. King <kingaa at umich.edu>
 Description: Inference methods for partially-observed Markov processes

Modified: pkg/man/pomp-package.Rd
===================================================================
--- pkg/man/pomp-package.Rd	2009-05-21 03:09:36 UTC (rev 132)
+++ pkg/man/pomp-package.Rd	2009-05-26 09:15:40 UTC (rev 133)
@@ -6,7 +6,10 @@
   The \code{pomp} package provides facilities for inference using partially-observed Markov processes (AKA state-space models or nonlinear stochastic dynamical systems).
   The user provides functions specifying some or all of the model's process and measurement components.
   The package's algorithms are built on top of these functions.
-  At the moment, algorithms are provided for particle filtering (AKA sequential Monte Carlo or sequential importance sampling) and the likelihood maximization by iterated filtering (MIF) method of Ionides, Breto, and King (PNAS, 103:18438-18443, 2006).
+  At the moment, algorithms are provided for
+  particle filtering (AKA sequential Monte Carlo or sequential importance sampling),
+  the likelihood maximization by iterated filtering (MIF) method of Ionides, Breto, and King (PNAS, 103:18438-18443, 2006),
+  and the nonlinear forecasting algorithm of Kendall, Ellner, et al. (Ecol. Monog. 75:259-276, 2005).
   Future support for a variety of other algorithms is envisioned.
   A working group of the National Center for Ecological Analysis and Synthesis (NCEAS), "Inference for Mechanistic Models", is currently implementing additional methods for this package.
 

Modified: pkg/man/pomp.Rd
===================================================================
--- pkg/man/pomp.Rd	2009-05-21 03:09:36 UTC (rev 132)
+++ pkg/man/pomp.Rd	2009-05-26 09:15:40 UTC (rev 133)
@@ -90,13 +90,15 @@
     An optional string giving the name of the dynamically loaded library in which the native routines are to be found.
   }
   \item{\dots}{
-    Any additional arguments are stored in a slot \code{userdata} and are passed as arguments to each of the functions \code{rprocess}, \code{dprocess}, \code{rmeasure}, \code{dmeasure}, and \code{initializer} whenever they are evaluated.
-    Using this mechanism, the user can store additional information necessary for the definition of the model.
+    Any additional arguments are passed as arguments to each of the functions \code{rprocess}, \code{dprocess}, \code{rmeasure}, \code{dmeasure}, and \code{initializer} whenever they are evaluated.
   }
 }
 \details{
-  \strong{It is the user's responsibility to ensure that the \code{rprocess}, \code{dprocess}, \code{rmeasure}, \code{dmeasure}, and \code{initializer} functions satisfy the following conditions:}
-  
+  \strong{
+    It is not typically necessary (or easy) to define all of the functions \code{rprocess}, \code{dprocess}, \code{rmeasure}, \code{dmeasure}, and \code{initializer} in any given problem.
+    Each algorithm makes use of a different subset of these functions.
+    If one of these functions is defined, it is the user's responsibility to ensure that it satisfies the following conditions:
+  }
   \describe{
     \item{\code{rprocess}}{
       if provided, must have at least the following arguments: