Skip to content

Commit

Permalink
tidy vignette and install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
pboesu committed Jan 6, 2023
1 parent 8b14209 commit 65cebdd
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,11 @@ The package `moultmcmc` is built around pre-compiled [Stan](https://mc-stan.org/
```r
install.packages("moultmcmc", repos = "https://pboesu.r-universe.dev")
```
On Mac and Windows systems this will make use of pre-compiled binaries, which means the models can be run without having to install a C++ compiler. On Linux this will install the package from a source tarball. Because of the way the Stan models are currently structured, compilation from source can be a lengthy process (15-45 minutes), depending on system setup and compiler toolchain.
On Mac and Windows systems this will make use of pre-compiled binaries, which means the models can be run without having to install a C++ compiler.
A Linux binary is available for `r-release` on `ubuntu:latest` and repository settings to obtain this are explained in the [r-universe help](https://github.com/r-universe-org/help#does-r-universe-have-linux-binaries).
For all other Linux platforms the above code will install the package from a source tarball. Because of the way the Stan models are currently structured, compilation from source can be a lengthy process (15-45 minutes), depending on system setup and compiler toolchain.

To install `moultmcmc` from the github source (not generally recommended for Windows users) use the following code. This requires a working C++ compiler and a working installation of [rstan](https://mc-stan.org/rstan):
To install `moultmcmc` from the github source (not generally recommended for MacOS or Windows users) use the following code. This requires a working C++ compiler and a working installation of [rstan](https://mc-stan.org/rstan):

```r
#not generally recommended for Windows/MacOS users
Expand Down
1 change: 0 additions & 1 deletion vignettes/extended-moult-models.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,6 @@ confint(lm(est_start ~ I(true_start - 196.83), data = ints))
cowplot::plot_grid(t3r_intercepts + theme(legend.position = 'none'),
t5r_intercepts + theme(legend.position = 'none'))
#TODO: I think the function now returns the internal index of the random effects vector but matches that to the global index of individuals?!
```

We find that agreement between simulations and estimates is good, even though the model does not explicitly account for heterogeneity in individual moult durations.
Expand Down

0 comments on commit 65cebdd

Please sign in to comment.