-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.Rmd
54 lines (37 loc) · 2.74 KB
/
README.Rmd
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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
rstansim: An R package for running simulation studies using stan
============================================
[](https://travis-ci.org/Ewan-Keith/rstansim)
[](https://ci.appveyor.com/project/Ewan-Keith/rstansim)
[](https://codecov.io/gh/Ewan-Keith/rstansim)
Overview
--------
rstansim provides a set of helper and utility functions to simplify running simulation studies using R and [stan](http://mc-stan.org/). The package addresses three aspects of running a simulation study:
* [Data simulation](https://ewan-keith.github.io/rstansim/articles/simulating_data.html).
* [Model fitting and capture of relevant data](https://ewan-keith.github.io/rstansim/articles/model-fitting.html).
* [Management of simulation results](https://ewan-keith.github.io/rstansim/articles/managing-results.html).
A small end to end example is demonstrated [here](https://ewan-keith.github.io/rstansim/articles/using-rstansim.html).
All simulation data is output in a [tidy](https://CRAN.R-project.org/package=tidyr/vignettes/tidy-data.html) format, for ease of interaction with [tidyverse](https://www.tidyverse.org/) packages for analysis and visualisation. Additionally reproducability information such as seeds, initial values, and data used, are stored alongside the data.
Installation
------------
```{r, eval=FALSE}
# Install latest version from cran
install.packages("rstansim")
# Or the the development version from GitHub:
# install.packages("devtools")
devtools::install_github("ewan-keith/rstansim")
```
Usage
-----
The four vignettes below provide exmples of how rstansim can be used to simplify simulation studies with stan. The first vignette provides a minimal, end to end example of a simualtion study and it is recommended that this is read first. The next three provide greater detail on the three primary aspects of running a simulation study listed above.
* Using rstansim to run a simulation study
* Simulating datasets using rstan and rstansim
* Model fitting and capture of relevant data
* Managing simulation results with rstansim
If looking to produce reproducable samples with stans own RNG functions then [read this note](https://ewan-keith.github.io/rstansim/articles/reproducability.html) on the behaviour of these functions.
Documentation
-----
Further information on the packages functions can be found at [the site reference](https://ewan-keith.github.io/rstansim/reference/index.html).