File: read.openbugs.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 (44 lines) | stat: -rw-r--r-- 1,184 bytes parent folder | download | duplicates (8)
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
\name{read.openbugs}
\alias{read.openbugs}
\title{Read CODA output files produced by OpenBUGS}

\usage{
read.openbugs(stem="", start, end, thin, quiet=FALSE)
}

\arguments{
  \item{stem}{Character string giving the stem for the output files.
    OpenBUGS produces files with names "<stem>CODAindex.txt",
    "<stem>CODAchain1.txt", "<stem>CODAchain2.txt", \ldots}
  \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.openbugs} reads Markov Chain Monte Carlo output in
   the CODA format produced by OpenBUGS.

   This is a convenience wrapper around the function \code{read.coda}
   which allows you to read all the data output by OpenBUGS by
   specifying only the file stem.
}

\value{
  An object of class \code{mcmc.list} containing output from all
  chains.
}

\references{
  Spiegelhalter DJ, Thomas A, Best NG and Lunn D (2004).
  \emph{WinBUGS User Manual, Version 2.0, June 2004},
  MRC Biostatistics Unit, Cambridge.
}

\author{Martyn Plummer}

\seealso{
   \code{\link{read.coda}}.
}
\keyword{file}