Skip to content

Commit

Permalink
improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kingaa committed Apr 4, 2020
1 parent ffb78bb commit c302c87
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 7 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Package: pomp
Type: Package
Title: Statistical Inference for Partially Observed Markov Processes
Version: 2.7.2.0
Date: 2020-04-01
Version: 2.7.2.1
Date: 2020-04-04
Authors@R: c(person(given=c("Aaron","A."),family="King",
role=c("aut","cre"),email="[email protected]"),
person(given=c("Edward","L."),family="Ionides",role=c("aut")),
Expand Down
3 changes: 2 additions & 1 deletion R/prior_spec.R
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@
##' When \code{give_log == 1}, \code{lik} should contain the log of the prior probability density.
##' \item Hyperparameters can be included in the ordinary parameter list.
##' }

##' \link[=Csnippet]{General rules for writing C snippets can be found here}.
##'
##' Alternatively, one can furnish \R functions for one or both of these arguments.
##' In this case, \code{rprior} must be a function of prototype \preformatted{
##' f(params, \dots)}
Expand Down
9 changes: 5 additions & 4 deletions R/skeleton_spec.R
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,19 @@
##' The skeleton is a dynamical system that expresses the central tendency of the unobserved Markov state process.
##' As such, it is not uniquely defined, but can be both interesting in itself and useful in practice.
##' In \pkg{pomp}, the skeleton is used by \code{\link{trajectory}} and \code{\link{traj.match}}.

##'
##' If the state process is a discrete-time stochastic process, then the skeleton is a discrete-time map.
##' To specify it, provide \preformatted{
##' skeleton = map(f, delta.t)}
##' to \code{pomp}, where \code{f} implements the map and \code{delta.t} is the size of the timestep covered at one map iteration.

##'
##' If the state process is a continuous-time stochastic process, then the skeleton is a vectorfield (i.e., a system of ordinary differential equations).
##' To specify it, supply \preformatted{
##' skeleton = vectorfield(f)}
##' to \code{pomp}, where \code{f} implements the vectorfield, i.e., the right-hand-size of the differential equations.

##'
##' In either case, \code{f} can be furnished either as a C snippet (the preferred choice), or an \R function.
##' \link[=Csnippet]{General rules for writing C snippets can be found here}.
##' In writing a \code{skeleton} C snippet, be aware that:
##' \enumerate{
##' \item For each state variable, there is a corresponding component of the deterministic skeleton.
Expand All @@ -33,7 +34,7 @@
##' \item As with the other C snippets, all states, parameters and covariates, as well as the current time, \code{t}, will be defined in the context within which the snippet is executed.
##' }
##' The tutorials on the \href{https://kingaa.github.io/pomp/}{package website} give some examples.

##'
##' If \code{f} is an \R function, its arguments should be taken from among the state variables, parameters, covariates, and time.
##' It must also take the argument \sQuote{\code{...}}.
##' As with the other basic components, \code{f} may take additional arguments, provided these are passed along with it in the call to \code{pomp}.
Expand Down
2 changes: 2 additions & 0 deletions man/prior_spec.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions man/skeleton_spec.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit c302c87

Please sign in to comment.