aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorKen Kellner <ken.kellner@gmail.com>2014-04-08 23:04:43 -0400
committerKen Kellner <ken.kellner@gmail.com>2014-04-08 23:14:46 -0400
commit4febcf79ac53e6ea8814869129238168514480d5 (patch)
tree7b958da4481631617bc27f3728ba4c1c900d22ac /man
parentb361f780d066ef2cb44d330ebbecc25df3604946 (diff)
Fix problem where some components of output object were vectors instead of lists (and change print function accordingly). Add option to save input data and initial values in model output object for future use.
Diffstat (limited to 'man')
-rw-r--r--man/simplejags.Rd19
1 files changed, 10 insertions, 9 deletions
diff --git a/man/simplejags.Rd b/man/simplejags.Rd
index 8439963..15e9482 100644
--- a/man/simplejags.Rd
+++ b/man/simplejags.Rd
@@ -15,7 +15,7 @@
\usage{
simplejags(data, inits, parameters.to.save, model.file,
- n.chains, n.adapt=0, n.iter, n.burnin=0, n.thin=1)}
+ n.chains, n.adapt=0, n.iter, n.burnin=0, n.thin=1, store.data=TRUE)}
\arguments{
\item{data}{A named list of the data objects required by the model.}
@@ -23,16 +23,17 @@ simplejags(data, inits, parameters.to.save, model.file,
list is itself a list of starting values for the \code{BUGS} model,
\emph{or} a function creating (possibly random) initial values. If inits is
\code{NULL}, \code{JAGS} will generate initial values for parameters.}
- \item{parameters.to.save}{character vector of the names of the
+ \item{parameters.to.save}{Character vector of the names of the
parameters to save which should be monitored.}
- \item{model.file}{file containing the model written in \code{BUGS} code}
- \item{n.chains}{number of Markov chains}
- \item{n.adapt}{number of iterations to run in the JAGS adaptive phase. Sometimes JAGS chooses
+ \item{model.file}{Path to file containing the model written in \code{BUGS} code}
+ \item{n.chains}{Number of Markov chains to run}
+ \item{n.adapt}{Number of iterations to run in the JAGS adaptive phase. Sometimes JAGS chooses
not to run these iterations; therefore they are separated from the burn-in in this package.}
- \item{n.iter}{number of total iterations per chain (including burn in)}
- \item{n.burnin}{length of burn in, i.e. number of iterations to
- discard at the beginning}
- \item{n.thin}{thinning rate. Must be a positive integer}
+ \item{n.iter}{number of total iterations per chain (including burn in).}
+ \item{n.burnin}{Length of burn in, i.e. number of iterations to
+ discard at the beginning of each chain.}
+ \item{n.thin}{Thinning rate. Must be a positive integer}
+ \item{store.data}{Option to store the input dataset and initial values in the model output object for future use. Defaults to TRUE.}
}
\author{