summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/lstbayes/README.md
blob: 5ea1e5d0ac9bb29b150b2ce4df2d809ed23af34e (plain)
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
53
54
# Listings language drivers for BUGS, JAGS, and Stan

[![CTAN](https://img.shields.io/ctan/v/lstbayes.svg)](https://www.ctan.org/pkg/lstbayes)
[![CTAN license](https://img.shields.io/ctan/l/lstbayes.svg)](https://www.ctan.org/pkg/lstbayes)

Adds support for the following languages to the LaTeX
[listings](http://www.ctan.org/pkg/listings/)
package, which pretty-prints source code:

- [BUGS](http://www.openbugs.net)
- [JAGS](http://mcmc-jags.sourceforge.net/)
- [Stan](http://mc-stan.org/)

# Usage

To use, load the package
```latex
\usepackage{lstbayes}
```
Then use `BUGS`, `JAGS` or `Stan` as a language in one of the listings environments or commands. For example, to format the Stan [Eight schools](https://raw.githubusercontent.com/wiki/stan-dev/rstan/8schools.stan) model,
```latex
\begin{lstlisting}[language=Stan]
data {
  int<lower=0> J; // number of schools 
  real y[J]; // estimated treatment effects
  real<lower=0> sigma[J]; // s.e. of effect estimates 
}
parameters {
  real mu; 
  real<lower=0> tau;
  real eta[J];
}
transformed parameters {
  real theta[J];
  for (j in 1:J)
    theta[j] <- mu + tau * eta[j];
}
model {
  eta ~ normal(0, 1);
  y ~ normal(theta, sigma);
}
\end{lstlisting}
```

Also see the examples in `examples.tex` and `examples.pdf` files included in this repository.
See the `listings` [documentation](https://www.ctan.org/pkg/listings/) for more on how to use the `listings` package.

# Issues

Development occurs on github at <https://github.com/jrnold/lstbayes>. 


<!--  LocalWords:  lstbayes tex usepackage lstlisting pdf
 -->