[Pomp-commits] r972 - pkg/pomp/man

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

Author: kingaa
Date: 2014-06-10 15:57:52 +0200 (Tue, 10 Jun 2014)
New Revision: 972

Modified:
   pkg/pomp/man/gompertz.Rd
   pkg/pomp/man/plugins.Rd
   pkg/pomp/man/pomp-package.Rd
   pkg/pomp/man/pomp.Rd
   pkg/pomp/man/sir.Rd
Log:
- repairs to the documentation

Modified: pkg/pomp/man/gompertz.Rd
===================================================================
--- pkg/pomp/man/gompertz.Rd	2014-06-10 13:21:48 UTC (rev 971)
+++ pkg/pomp/man/gompertz.Rd	2014-06-10 13:57:52 UTC (rev 972)
@@ -18,6 +18,6 @@
 coef(gompertz,transform=TRUE)
 }
 \seealso{
-  the \dQuote{Introduction to \pkg{pomp}} vignette
+  the \href{http://pomp.r-forge.r-project.org/vignettes/intro_to_pomp.pdf}{\dQuote{Introduction to \pkg{pomp}}} tutorial.
 }
 \keyword{datasets}

Modified: pkg/pomp/man/plugins.Rd
===================================================================
--- pkg/pomp/man/plugins.Rd	2014-06-10 13:21:48 UTC (rev 971)
+++ pkg/pomp/man/plugins.Rd	2014-06-10 13:57:52 UTC (rev 972)
@@ -27,7 +27,7 @@
     \code{params} is a named numeric vector containing parameters,
     and \code{delta.t} is the length of the Euler time-step.
 
-    For examples on the use of \code{\link{Csnippet}} to write fast simulators easily, see the \dQuote{Introduction to \pkg{pomp}} document, included with the package.
+    For examples on the use of \code{\link{Csnippet}} to write fast simulators easily, see the \dQuote{Introduction to \pkg{pomp}} tutorial vignette, available on the \href{http://pomp.r-forge.r-project.org}{package website}.
 
     If \code{step.fun} is the name of a native function, it must be of type \dQuote{pomp_onestep_sim} as defined in the header \dQuote{pomp.h}, which is included with the \pkg{pomp} package.
     For details on how to write such codes, see Details.
@@ -39,7 +39,7 @@
     \code{x} is a named numeric vector containing the value of the state process at time \code{t} and 
     \code{params} is a named numeric vector containing parameters.
 
-    For examples on the use of \code{\link{Csnippet}} to write fast simulators easily, see the \dQuote{Introduction to \pkg{pomp}} document, included with the package.
+    For examples on the use of \code{\link{Csnippet}} to write fast simulators easily, see the \dQuote{Introduction to \pkg{pomp}} tutorial vignette, available on the \href{http://pomp.r-forge.r-project.org}{package website}.
 
     If \code{rate.fun} is a native function, it must be of type \dQuote{pomp_ssa_rate_fn} as defined in the header \dQuote{pomp.h}, which is included with the package.
     For details on how to write such codes, see Details.

Modified: pkg/pomp/man/pomp-package.Rd
===================================================================
--- pkg/pomp/man/pomp-package.Rd	2014-06-10 13:21:48 UTC (rev 971)
+++ pkg/pomp/man/pomp-package.Rd	2014-06-10 13:57:52 UTC (rev 972)
@@ -8,7 +8,7 @@
   The first step in using \pkg{pomp} is to encode one's model and data in an object of class \code{pomp}.
   One does this via a call to \code{\link{pomp}}, which involves specifying the process and measurement components of the model in one or more of a variety of ways.
   Details on this are given in the documentation for the \code{\link{pomp}} function.
-  Examples are given in the \sQuote{Introduction to \pkg{pomp}} document, in the demos (\code{demo(package='pomp')}), and via the \code{\link{pompExample}} function.
+  Examples are given in the \href{http://pomp.r-forge.r-project.org/vignettes/intro_to_pomp.pdf}{\dQuote{Introduction to \pkg{pomp}}} document, in the demos (\code{demo(package='pomp')}), and via the \code{\link{pompExample}} function.
 
   \pkg{pomp} version \Sexpr[echo=F,stage=install,results=text]{packageDescription("pomp",fields="Version")} provides algorithms for
   \enumerate{
@@ -37,8 +37,8 @@
   The basic class, \code{\link{pomp}}, encodes a partially-observed Markov process together with a uni- or multi-variate data set and (possibly) parameters.
 }
 \section{Documentation}{
-  The \href{http://pomp.r-forge.r-project.org/vignettes/index.html}{\sQuote{Introduction to \pkg{pomp}}} document illustrates the facilities of the package using familiar stochastic processes.
-  The \href{http://pomp.r-forge.r-project.org/vignettes/index.html}{\sQuote{Advanced topics in \pkg{pomp}}} document discusses the low-level interface and some more advanced modeling techniques.
+  The \href{http://pomp.r-forge.r-project.org/vignettes/intro_to_pomp.pdf}{\sQuote{Introduction to \pkg{pomp}}} document illustrates the facilities of the package using familiar stochastic processes.
+  The \href{http://pomp.r-forge.r-project.org/vignettes/advanced_topics_in_pomp.pdf}{\sQuote{Advanced topics in \pkg{pomp}}} document discusses the low-level interface and some more advanced modeling techniques.
   These documents can be viewed at \url{http://pomp.r-forge.r-project.org}.
 }
 \references{

Modified: pkg/pomp/man/pomp.Rd
===================================================================
--- pkg/pomp/man/pomp.Rd	2014-06-10 13:21:48 UTC (rev 971)
+++ pkg/pomp/man/pomp.Rd	2014-06-10 13:57:52 UTC (rev 972)
@@ -300,8 +300,8 @@
   }
 }
 \examples{
-## For examples, see the \dQuote{Introduction to \pkg{pomp}}
-## and \dQuote{Advanced topics in \pkg{pomp}} documents,
+## For examples, see the "Introduction to pomp"
+## and "Advanced topics in pomp" documents,
 ## the demos, and the examples provided with the package, e.g.:
 \dontrun{
 pompExample()

Modified: pkg/pomp/man/sir.Rd
===================================================================
--- pkg/pomp/man/sir.Rd	2014-06-10 13:21:48 UTC (rev 971)
+++ pkg/pomp/man/sir.Rd	2014-06-10 13:57:52 UTC (rev 972)
@@ -11,7 +11,7 @@
   \code{bbs} is a nonseasonal SIR model together with data from a 1978 outbreak of influenza in a British boarding school.
 }
 \details{
-  This example is discussed extensively in the \dQuote{Introduction to \pkg{pomp}} and \dQuote{Advanced topics in \pkg{pomp}} vignettes.
+  This example is discussed extensively in the \dQuote{Introduction to \pkg{pomp}} and \dQuote{Advanced topics in \pkg{pomp}} vignettes, available on the \href{http://pomp.r-forge.r-project.org}{package website}.
 
   The codes that construct these \code{pomp} objects can be found in the \dQuote{examples} directory in the installed package.
   Do \code{system.file("examples",package="pomp"))} to find this directory.