Skip to content
This repository was archived by the owner on Mar 21, 2025. It is now read-only.

Commit 0efd1aa

Browse files
committed
Rel 4.5.0 - README updates
1 parent 7e20c67 commit 0efd1aa

File tree

3 files changed

+17
-5491
lines changed

3 files changed

+17
-5491
lines changed

README.md

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ SR2TuringPluto is a Julia project that uses Pluto notebooks for this purpose. Ea
77

88
This Julia project uses Turing as the underlying mcmc implementation. A companion project ( [SR2StanPluto.jl](https://github.com/StatisticalRethinkingJulia/SR2StanPluto.jl) ) uses Stan.
99

10-
**Note: A new version (v5.0.0) is under development. This is a breaking version. Probably safe to stick with tagged version 4.0.3 until then.**
11-
1210
## Installation
1311

1412
To (locally) reproduce and use this project, do the following:
@@ -25,23 +23,12 @@ If you want a specific tagged version, use:
2523
```
2624
$ git tag -l # To see available tags, followed by:
2725
$ git checkout tags/<tag_name> # or simply:
28-
$ git checkout v4.0.3
26+
$ git checkout v4.5.0
2927
```
3028

31-
and in the Julia REPL:
32-
33-
```
34-
julia> ] # Actvate Pkg mode
35-
(@v1.8) pkg> activate . # Activate pkg in .
36-
(SR2TuringPluto) pkg> instantiate # Install in pkg environment
37-
(SR2TuringPluto) pkg> <delete> # Exit package mode
38-
```
39-
40-
If above procedure fails, if present, try to delete the Manifest.toml file and repeat above steps. **These steps are only needed the first time.**
41-
4229
The next step assumes your Julia setup includes at least `Pkg`, `DrWatson`, `Pluto` and `PlutoUI`.
4330

44-
2. Start a Pluto notebook server.
31+
2. Start a Pluto notebook server in the Julia REPL:
4532
```
4633
$ julia
4734
@@ -53,16 +40,14 @@ julia> Pluto.run()
5340

5441
## Usage
5542

56-
Note: *SR2TuringPluto v4 requires StatisticalRethinking.jl v 4.*
43+
Note: *SR2TuringPluto v4 requires StatisticalRethinking.jl v4.*
5744

5845
Select a notebook in the `open a file` entry box, e.g. type `./` and step to `./notebooks/TuringGuide.jl`.
5946

6047
SR2TuringPluto.jl is a DrWatson project, with some added/re-purposed subdirectories,
6148

6249
The `data` directory, in DrWatson accessible through `datadir()`, can be used for locally generated data, exercises, etc. All "rethinking" data files are stored and maintained in StatisticalRethinking.jl and can be accessed via `sr_datadir(...)`.
6350

64-
The scripts in the `scripts` subdirectory are directly generated from the notebooks and thus adhere to Pluto's programming restrictions.
65-
6651
This leads to a typical set of opening lines in each notebook:
6752
```
6853
using Pkg, DrWatson
@@ -85,7 +70,7 @@ df = df[df.age .>= 18, :]
8570

8671
## Naming of models and results:
8772

88-
1. ppl5_1 or m5_1 : Turing model
73+
1. ppl5_1 : Turing model
8974
1. m5_1t : The instantiated Turing model (includes data)
9075

9176
Chain(s):
@@ -101,27 +86,38 @@ Results as a DataFrame:
10186

10287
As before, the `t` at the end of the model number indicates Turing.
10388

89+
**Note**: Naming is not yet consistent through all notebooks. Work in progress!
90+
10491
## Status
10592

10693
SR2TuringPluto.jl is compatible with the 2nd edition of the book.
10794

10895
StructuralCausalModels.jl and ParetoSmoothedImportanceSampling.jl are included as experimental dependencies in the StatisticalRethinking.jl v3 package. Definitely work in progress!
10996

97+
Max Lapan added a package Dagitty.jl which coversoptions similar as available in StructuralCausalModels.jl. There is also a new package, ParetoSmooth.jl which overlaps with ParetoSmoothedImportanceSampling.jl.
98+
As terminology differs from the terminology used in the Statistical Rethinking book, I have not used this package in the notebooks (yet?).
99+
100+
**Note: A new version (v5.0.0) is under development. This is a breaking version. Probably safe to stick with tagged version 4.0.3 until then.**
101+
110102
Any feedback is appreciated. Please open an issue.
111103

112104
## Acknowledgements
113105

114106
Of course, without the excellent textbook by Richard McElreath, this package would not have been possible. The author has also been supportive of this work and gave permission to use the datasets.
115107

116-
This repository and format is derived from work by Max Lapan, Karajan, previous and Stan versions of StatisticalRethinking.jl and many other contributors.
108+
This repository is derived from work by Max Lapan, Karajan, previous and current Stan versions of StatisticalRethinking.jl. It has been improved through comments and suggestions of many other contributors.
117109

118110
## Versions
119111

120112
### Version 5.0.0 (Under development, will take time)
121113

122114
1. Complete overhaul.likely using Makie.jl, Graphs.jl and more.
123115
2. Larger notebooks.
124-
3. Dropped additional figures in early chapters. r
116+
3. Dropped additional figures in early chapters.
117+
118+
### Version 4.5.0
119+
120+
1. Adapted chapters 5 to 14 to an initial Pluto format.
125121

126122
### Version 4.0.5
127123

0 commit comments

Comments
 (0)