File: read.coda.Rd

package info (click to toggle)
r-cran-coda 0.13-2-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 456 kB
  • sloc: makefile: 2
file content (52 lines) | stat: -rw-r--r-- 1,687 bytes parent folder | download | duplicates (10)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
\name{read.coda}
\alias{read.coda}
\alias{read.jags}
\title{Read output files in CODA format}

\usage{
read.coda(output.file, index.file, start, end, thin, quiet=FALSE)
read.jags(file = "jags.out", start, end, thin, quiet=FALSE)
}

\arguments{
  \item{output.file}{The name of the file containing the monitored
    output}
  \item{index.file}{The name of the file containing the index, showing
    which rows of the output file correspond to which variables}
  \item{file}{For JAGS output, the name of the output file.  The
    extension ".out" may be omitted. There must be a corresponding
    ".ind" file with the same file stem.}
  \item{start}{First iteration of chain}
  \item{end}{Last iteration of chain}
  \item{thin}{Thinning interval for chain}
  \item{quiet}{Logical flag. If true, a progress summary will be printed}
}

\description{
   \code{read.coda} reads Markov Chain Monte Carlo output in
   the CODA format produced by OpenBUGS and JAGS. By default, all
   of the data in the file is read, but the arguments \code{start},
   \code{end} and \code{thin} may be used to read a subset of the
   data.  If the arguments given to \code{start}, \code{end} or
   \code{thin} are incompatible with the data, they are ignored.
}

\value{
   An object of class \code{mcmc} containing a representation of 
   the data in the file.
}

\references{
   Spiegelhalter DJ, Thomas A, Best NG and Gilks WR (1995).
   \emph{BUGS: Bayesian inference Using Gibbs Sampling, Version 0.50.}
   MRC Biostatistics Unit, Cambridge.
}

\author{Karen Vines, Martyn Plummer}

\seealso{
   \code{\link{mcmc}}, 
   \code{\link{read.coda.interactive}},
   \code{\link{read.openbugs}}.
}
\keyword{file}