[Pomp-commits] r82 - pkg/man

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

Author: kingaa
Date: 2009-04-10 18:37:44 +0200 (Fri, 10 Apr 2009)
New Revision: 82

Modified:
   pkg/man/mif-class.Rd
   pkg/man/mif-methods.Rd
Log:
fix some documentation infelicities and bugs

Modified: pkg/man/mif-class.Rd
===================================================================
--- pkg/man/mif-class.Rd	2009-03-16 11:30:06 UTC (rev 81)
+++ pkg/man/mif-class.Rd	2009-04-10 16:37:44 UTC (rev 82)
@@ -33,18 +33,10 @@
     \item{alg.pars}{
       A named list of algorithm parameters.
       This consists of
-      \item{Np}{
-	the number of particles to use in filtering.
-      }
-      \item{var.factor}{
-	the scaling coefficient relating the width of the initial particle distribution to \code{rw.sd}.
-      }
-      \item{ic.lag}{
-	the fixed lag used in the estimation of initial-value parameters (IVPs).
-      }
-      \item{cooling.factor}{
-	the exponential cooling factor, \code{alpha}, where \code{0<alpha<1}.
-      }
+      \code{Np}, the number of particles to use in filtering; 
+      \code{var.factor}, the scaling coefficient relating the width of the initial particle distribution to \code{rw.sd};
+      \code{ic.lag}, the fixed lag used in the estimation of initial-value parameters (IVPs);
+      and \code{cooling.factor}, the exponential cooling factor, \code{alpha}, where \code{0<alpha<1}.
     }
     \item{random.walk.sd}{
       A named vector containing the random-walk variance to be used for ordinary parameters.
@@ -77,7 +69,12 @@
       A numeric value containing the value of the log likelihood, as evaluated for the random-parameter model.
       Note that this will not be equal to the log likelihood for the fixed-parameter model.
     }
-    \item{data, times, t0, rprocess, dprocess, dmeasure, rmeasure, skeleton.type, skeleton, initializer, states, params, statenames, paramnames, covarnames, tcovar, covar, PACKAGE, userdata}{Inherited from the \code{pomp} class.}
+    \item{data, times, t0, rprocess, dprocess, dmeasure, rmeasure,
+      skeleton.type, skeleton, initializer, states, params,
+      statenames, paramnames, covarnames, tcovar, covar,
+      PACKAGE, userdata}{
+      Inherited from the \code{pomp} class.
+    }
   }
 }
 \section{Extends}{

Modified: pkg/man/mif-methods.Rd
===================================================================
--- pkg/man/mif-methods.Rd	2009-03-16 11:30:06 UTC (rev 81)
+++ pkg/man/mif-methods.Rd	2009-04-10 16:37:44 UTC (rev 82)
@@ -77,7 +77,7 @@
     }
     \item{predvarplot}{
       \code{predvarplot(object, pars = NULL, mean = FALSE, \dots)} produces a plot of the scaled prediction variances for each parameter.
-      This can be used to diagnose a good value of the \code{mif} parameters \code{CC} and \code{T0}.
+      This can be used to diagnose a good value of the \code{mif} parameters \code{var.factor} and \code{ic.lag}.
       If used in this way, one should run \code{mif} with \code{Nmif=1} first.
       Additional arguments in \code{\dots} will be passed to the actual plotting function.
     }