[Pomp-commits] r95 - pkg/man

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

Author: kingaa
Date: 2009-04-16 14:03:40 +0200 (Thu, 16 Apr 2009)
New Revision: 95

Modified:
   pkg/man/mif.Rd
Log:
fix order of arguments in documentation for 'mif'


Modified: pkg/man/mif.Rd
===================================================================
--- pkg/man/mif.Rd	2009-04-14 14:48:19 UTC (rev 94)
+++ pkg/man/mif.Rd	2009-04-16 12:03:40 UTC (rev 95)
@@ -15,8 +15,9 @@
 \usage{
 mif(object, \dots)
 \S4method{mif}{pomp}(object, Nmif = 1, start, pars, ivps = character(0),
-    particles, rw.sd, Np, cooling.factor, var.factor, ic.lag, alg.pars, weighted = TRUE,
-    tol = 1e-17, warn = TRUE, max.fail = 0, verbose = FALSE)
+    particles, rw.sd, alg.pars, Np, ic.lag, var.factor, cooling.factor,
+    weighted = TRUE, tol = 1e-17, warn = TRUE, max.fail = 0,
+    verbose = FALSE)
 \S4method{mif}{mif}(object, Nmif, \dots)
 \S4method{continue}{mif}(object, Nmif = 1, \dots)
 }
@@ -55,6 +56,11 @@
     \code{rw.sd} must be non-negative (zeros are simply ignored),
     the name of every positive element of \code{rw.sd} must be in either \code{pars} or \code{ivps}.
   }
+  \item{alg.pars}{
+    optional; a named list of the algorithm parameters \code{Np}, \code{cooling.factor}, \code{var.factor}, \code{ic.lag}.
+    The use of \code{alg.pars} is now deprecated and generates a warning.
+    It will be removed in the near future.
+  }
   \item{Np}{
     a positive integer;
     the number of particles to use in filtering
@@ -71,11 +77,6 @@
     a positive number not greater than 1;
     the exponential cooling factor, \code{alpha}.
   }
-  \item{alg.pars}{
-    optional; a named list of the algorithm parameters \code{Np}, \code{cooling.factor}, \code{var.factor}, \code{ic.lag}.
-    The use of \code{alg.pars} is now deprecated and generates a warning.
-    It will be removed in the near future.
-  }
   \item{weighted}{
     Should a weighted average be used?
     If \code{weighted=F}, the MIF update is not used;