[Rcpp-commits] r3516 - in pkg/RcppSMC: . man

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

Author: adamj
Date: 2012-03-17 10:50:57 +0100 (Sat, 17 Mar 2012)
New Revision: 3516

Modified:
   pkg/RcppSMC/ChangeLog
   pkg/RcppSMC/man/pfEx.Rd
Log:
Documentation update to reflect yesterday's changes to pfEx.


Modified: pkg/RcppSMC/ChangeLog
===================================================================
--- pkg/RcppSMC/ChangeLog	2012-03-17 09:47:08 UTC (rev 3515)
+++ pkg/RcppSMC/ChangeLog	2012-03-17 09:50:57 UTC (rev 3516)
@@ -1,4 +1,5 @@
 2012-03-17  Adam Johansen <a.m.johansen at warwick.ac.uk>
+	* man/pfEx.Rd updated to reflect previous changes.
 
 	* NAMESPACE removed rareEvents
 	* src/rareEvents.cpp moved to src/rareEvents.

Modified: pkg/RcppSMC/man/pfEx.Rd
===================================================================
--- pkg/RcppSMC/man/pfEx.Rd	2012-03-17 09:47:08 UTC (rev 3515)
+++ pkg/RcppSMC/man/pfEx.Rd	2012-03-17 09:50:57 UTC (rev 3516)
@@ -13,7 +13,7 @@
   estimation process. 
 }
 \usage{
-  pfEx(data, particles=1000, plot=FALSE) 
+  pfEx(data, particles=1000, plot=FALSE, onlinePlot) 
   pfExOnlinePlot(xm, ym)
 }
 \arguments{
@@ -23,6 +23,9 @@
   \item{particles}{An integer specifying the number of particles.}
   \item{plot}{A boolean variable describing whether plot should
     illustrate the estimated path along with the data.}
+  \item{onlinePlot}{A user-supplied callback function which is called with the
+  x and y position vectors during each iteration of the algorithm; see
+  pfExOnlinePlot for a simple example.}
   \item{xm}{Vector with x position.}
   \item{ym}{Vector with y position.}
 }
@@ -50,6 +53,7 @@
 \examples{
 \dontrun{
   res <- pfEx(plot=TRUE)
+  res <- pfEx(onlinePlot=pfExOnlinePlot)
 }
 }
 \author{Adam M. Johansen for SMCTC, Dirk Eddelbuettel for the RcppSMC wrapper.}