Skip to content

Commit 5b1563c

Browse files
committed
add links to overview pages
1 parent 0a9c2a0 commit 5b1563c

File tree

4 files changed

+44
-31
lines changed

4 files changed

+44
-31
lines changed

src/functions-reference/_bookdown.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
new_session: TRUE
1+
new_session: FALSE
2+
delete_merged_file: TRUE
23

34
rmd_files: [
45
"index.Rmd",
@@ -35,4 +36,3 @@ rmd_files: [
3536
"references.Rmd"
3637
]
3738

38-
delete_merged_file: TRUE

src/functions-reference/index.Rmd

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ subtitle: "`r paste('Version', Sys.getenv('STAN_DOCS_VERSION'))`"
55
author: "Stan Development Team"
66
description: "Reference for the functions defined in the Stan math library and available in the Stan programming language."
77
site: bookdown::bookdown_site
8+
cover-image: img/logo_tm.png
89
documentclass: book
910
bibliography: [../bibtex/all.bib]
1011
biblio-style: apalike
@@ -13,11 +14,10 @@ fontsize: 10pt
1314
monofont: "Lucida Console"
1415
subparagraph: yes
1516
---
16-
# <i style="font-size: 110%; padding:1.5em 0 0 0; color:#990017;">Overview</i> {-}
1717

18-
<img style="float:right; margin: -2em 0em 4em 4em" src="img/logo_tm.png" width="225" alt="Stan logo" />
18+
# <i style="font-size: 110%; padding:1.5em 0 0 0; color:#990017;">Overview</i> {-}
1919

20-
#### About {-}
20+
<img style="float:right; margin: -2em 0em 4em 4em" src="https://mc-stan.org/images/stan_logo.png" width="225" alt="Stan logo" />
2121

2222
This is the reference for the functions defined in the Stan math
2323
library and available in the Stan programming language.
@@ -28,16 +28,29 @@ probability library, algorithms for Bayesian posterior inference and
2828
posterior analysis, along with interfaces and analysis tools in all of
2929
the popular data analysis languages.
3030

31+
In addition to this reference manual, there is a user's guide and
32+
a language reference manual for the Stan language and algorithms.
33+
The [*Stan User's Guide*](https://mc-stan.org/docs/stan-users-guide/index.html)
34+
provides example models and programming
35+
techniques for coding statistical models in Stan.
36+
The [*Stan Reference Manual*](https://mc-stan.org/docs/reference-manual/index.html)
37+
specifies the Stan programming language
38+
and inference algorithms.
39+
40+
There is also a separate installation and getting started guide for
41+
each of the Stan interfaces (R, Python, Julia, Stata, MATLAB,
42+
Mathematica, and command line).
3143

3244
#### Interfaces and Platforms {-}
3345

3446
Stan runs under Windows, Mac OS X, and Linux.
3547

3648
Stan uses a domain-specific programming language that is portable
37-
across data anlsysi languages. Stan has interfaces for R, Python,
49+
across data analysis languages. Stan has interfaces for R, Python,
3850
Julia, MATLAB, Mathematica, Stata, and the command line, as well
39-
as an alternative language interface in Scala. See the web
40-
site (link below) for links and getting started instructions.
51+
as an alternative language interface in Scala. See the web site
52+
[https://mc-stan.org](https://mc-stan.org) for interface-specific
53+
links and getting started instructions
4154

4255
#### Web Site {-}
4356

src/reference-manual/index.Rmd

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,19 @@ subparagraph: yes
1717

1818
# <i style="font-size: 110%; padding:1.5em 0 0 0; color:#990017;">Overview</i> {-}
1919

20-
<img style="float:right; margin: -2em 0em 4em 4em" src="img/logo_tm.png" width="225" alt="Stan logo" />
20+
<img style="float:right; margin: -2em 0em 4em 4em" src="https://mc-stan.org/images/stan_logo.png" width="225" alt="Stan logo" />
2121

2222
This is the official reference manual for Stan's *programming
2323
language* for coding probability models, *inference algorithms* for
2424
fitting models and making predictions, and *posterior analysis* tools
2525
for evaluating the results. This manual applies to all Stan
26-
inteferfaces.
26+
interfaces.
2727

28-
There are two additional interface-neutral manuals, a *Functions
29-
Reference* listing all the built-in functions and their signatures,
30-
and a *User's Guide* providing examples and programming techniques.
28+
There are two additional interface-neutral manuals, the
29+
[*Stan Functions Reference*]((https://mc-stan.org/docs/functions-reference/index.html)
30+
listing all the built-in functions and their signatures,
31+
and the [*Stan User's Guide*]((https://mc-stan.org/docs/stan-users-guide/index.html)
32+
providing examples and programming techniques.
3133
There is also a separate installation and getting started guide for
3234
each interface.
3335

src/stan-users-guide/index.Rmd

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -16,41 +16,39 @@ monofont: "Lucida Console"
1616
subparagraph: yes
1717
---
1818

19-
# About this Book {-}
19+
# <i style="font-size: 110%; padding:1.5em 0 0 0; color:#990017;">Overview</i> {-}
2020

2121
<img style="float:right; margin: -2em 0em 4em 4em" src="img/logo-tm.png" width="225" alt="Stan logo" />
2222

23-
This book is the official user's guide for Stan. It provides example
24-
models and programming techniques for coding statistical models in Stan.
23+
#### About this user's guide {-}
2524

26-
#### How to use this book {-}
25+
This is the official user's guide for Stan. It provides example
26+
models and programming techniques for coding statistical models in Stan.
2727

28-
Part 1 gives Stan code and discussions for several important classes
28+
- Part 1 gives Stan code and discussions for several important classes
2929
of models.
3030

31-
Part 2 discusses various general Stan programming techniques that are
31+
- Part 2 discusses various general Stan programming techniques that are
3232
not tied to any particular model.
3333

34-
The appendices provide a style guide and advice for users of BUGS and JAGS.
35-
36-
We recommend working through this book using the textbooks _Bayesian
37-
Data Analysis_ and _Statistical Rethinking: A Bayesian Course with
38-
Examples in R and Stan_ as references on the concepts, and using the
39-
Stan Reference Manual when necessary to clarify programming issues.
40-
Further resources are given at the end of the introductory chapter.
41-
42-
#### Additional Stan manuals and guides {-}
34+
- The appendices provide a style guide and advice for users of BUGS and JAGS.
4335

4436
In addition to this user's guide, there are two reference manuals for
45-
the Stan language and algorithms. The *Stan Reference Manual*
37+
the Stan language and algorithms. The [*Stan Reference Manual*](https://mc-stan.org/docs/reference-manual/index.html)
4638
specifies the Stan programming language and inference algorithms. The
47-
*Stan Functions Reference* specifies the functions built into the Stan
48-
programming language.
39+
[*Stan Functions Reference*](https://mc-stan.org/docs/functions-reference/index.html)
40+
specifies the functions built into the Stan programming language.
4941

5042
There is also a separate installation and getting started guide for
5143
each of the Stan interfaces (R, Python, Julia, Stata, MATLAB,
5244
Mathematica, and command line).
5345

46+
We recommend working through this guide using the textbooks _Bayesian
47+
Data Analysis_ and _Statistical Rethinking: A Bayesian Course with
48+
Examples in R and Stan_ as references on the concepts, and using the
49+
[*Stan Reference Manual*](https://mc-stan.org/docs/reference-manual/index.html)
50+
when necessary to clarify programming issues.
51+
5452
#### Web resources {-}
5553

5654
Stan is an open-source software project, resources for which are

0 commit comments

Comments
 (0)