File: read.jagsdata.Rd

package info (click to toggle)
r-cran-rjags 1%3A4-16-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 496 kB
  • sloc: cpp: 673; ansic: 81; makefile: 2; sh: 2
file content (48 lines) | stat: -rw-r--r-- 1,749 bytes parent folder | download | duplicates (6)
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
\name{read.jagsdata}
\alias{read.jagsdata}
\alias{read.bugsdata}
\title{Read data files for jags models}
\description{
  Read data for a JAGS model from a file.
}
\usage{
read.jagsdata(file)
read.bugsdata(file)
}
\arguments{
  \item{file}{name of a file containing a text repesentation of the
    data for a jags model}
}
\value{
  A named list of numeric vectors or arrays. 
}
\details{
  
  The command line interface for JAGS reads data and initial values from
  a text file.  The data format used for jags data files is the same as the R
  \code{dump} function. Thus the data values can be read into an
  R session using the \code{source} function, but this will create
  objects in the global environment. The \code{read.jagsdata} function
  is a simple wrapper that reads the data into a list instead.

  OpenBUGS also reads data and initial values from a text file. The
  format of these files is described as "S-PLUS" format by the OpenBUGS
  authors. It superficially resembles the format used by the \code{dput}
  function (and in fact can be parsed by the \code{dget}
  function). However, in BUGS "S-PLUS" format, arrays are stored in
  row-major order instead of the column-major order used by R.  The
  \code{read.bugsdata} function reads OpenBUGS "S-PLUS" format files and
  permutes the elements of arrays so that they appear in the correct
  order.

  Either function returns a list which can be used as the
  \code{data} or \code{inits} argument of \code{jags.model}.

}
\note{
  Earlier versions of the rjags package had a \code{read.data} function
  which read data in either format, but the function name was ambiguous
  (There are many data file format in R) so this is now deprecated.
}
\author{Martyn Plummer}
\keyword{file}