Skip to content

Commit a547222

Browse files
committed
Link to example project and bump version
1 parent 2dec057 commit a547222

File tree

6 files changed

+24
-6
lines changed

6 files changed

+24
-6
lines changed

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Description: Bayesian data analysis usually incurs long runtimes
1414
both single-fit workflows and multi-rep simulation studies.
1515
For the statistical methodology, please refer to 'Stan' documentation
1616
(Stan Development Team 2020) <https://mc-stan.org/>.
17-
Version: 0.0.0.9003
17+
Version: 0.0.1
1818
License: MIT + file LICENSE
1919
URL: https://docs.ropensci.org/stantargets/, https://github.com/ropensci/stantargets
2020
BugReports: https://github.com/ropensci/stantargets/issues

NEWS.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# stantargets 0.0.0.9003
1+
# stantargets 0.0.1
22

33
* Skip tests if CmdStan is not installed (@sakrejda).
44
* Use custom `generate_data()` function in the docs, as opposed to `tar_stan_example_data()` directly (@sakrejda).
@@ -12,6 +12,7 @@
1212
* Use `@family` go cross-reference functions (@mattwarkentin).
1313
* Elaborate on the roles and return values of specific targets generated by target factories (@mattwarkentin).
1414
* Undergo rOpenSci peer review and transition to rOpenSci.
15+
* Link to an example project.
1516

1617
# stantargets 0.0.0.9002
1718

README.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The `stantargets` R package is an extension to [`targets`](https://docs.ropensci
3737

3838
## How to get started
3939

40-
Read the `stantargets` tutorial vignettes [here](https://docs.ropensci.org/stantargets/articles/mcmc.html) and [here](https://docs.ropensci.org/stantargets/articles/mcmc_rep.html), then use <https://docs.ropensci.org/stantargets/> as a reference while constructing your own workflows.
40+
Read the `stantargets` tutorial vignettes [here](https://docs.ropensci.org/stantargets/articles/mcmc.html) and [here](https://docs.ropensci.org/stantargets/articles/mcmc_rep.html), and use <https://docs.ropensci.org/stantargets/> as a reference while constructing your own workflows. Visit <https://github.com/wlandau/stantargets-example-validation> for an example project based on <https://docs.ropensci.org/stantargets/articles/mcmc_rep.html>. The example has an [RStudio Cloud workspace](https://rstudio.cloud/project/2466069) which allows you to run the project in a web browser.
4141

4242
## Installation
4343

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,14 @@ pipelines](https://docs.ropensci.org/stantargets/articles/mcmc.html).
5959
Read the `stantargets` tutorial vignettes
6060
[here](https://docs.ropensci.org/stantargets/articles/mcmc.html) and
6161
[here](https://docs.ropensci.org/stantargets/articles/mcmc_rep.html),
62-
then use <https://docs.ropensci.org/stantargets/> as a reference while
63-
constructing your own workflows.
62+
and use <https://docs.ropensci.org/stantargets/> as a reference while
63+
constructing your own workflows. Visit
64+
<https://github.com/wlandau/stantargets-example-validation> for an
65+
example project based on
66+
<https://docs.ropensci.org/stantargets/articles/mcmc_rep.html>. The
67+
example has an [RStudio Cloud
68+
workspace](https://rstudio.cloud/project/2466069) which allows you to
69+
run the project in a web browser.
6470

6571
## Installation
6672

inst/WORDLIST

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -352,3 +352,4 @@ SBC
352352
stdout
353353
stderr
354354
HMC
355+
mcmc

vignettes/mcmc_rep.Rmd

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,22 @@ if (identical(Sys.getenv("IN_PKGDOWN"), "true")) {
3030
}
3131
```
3232

33+
## Background
34+
3335
It is sometimes desirable to run one or more Bayesian models repeatedly across multiple simulated datasets. Examples:
3436

3537
1. Validate the implementation of a Bayesian model using simulation.
3638
2. Simulate a randomized controlled experiment to explore frequentist properties such as power and Type I error.
3739

38-
This vignette focuses on (1). The goal of this particular example to simulate multiple datasets from the model below, analyze each dataset, and assess how often the estimated posterior intervals cover the true parameters from the prior predictive simulations. The quantile method by @cook2006 generalizes this concept, and simulation-based calibration [@talts2020] generalizes further. The interval-based technique featured in this vignette is not as robust as SBC, but it may be more expedient for large models because it does not require visual inspection of multiple histograms.
40+
This vignette focuses on (1).
41+
42+
## Example project
43+
44+
Visit <https://github.com/wlandau/stantargets-example-validation> for an example project based on this vignette. The example has an [RStudio Cloud workspace](https://rstudio.cloud/project/2466069) which allows you to run the project in a web browser.
45+
46+
## Simulation-based validation study
47+
48+
The goal of this particular example to simulate multiple datasets from the model below, analyze each dataset, and assess how often the estimated posterior intervals cover the true parameters from the prior predictive simulations. The quantile method by @cook2006 generalizes this concept, and simulation-based calibration [@talts2020] generalizes further. The interval-based technique featured in this vignette is not as robust as SBC, but it may be more expedient for large models because it does not require visual inspection of multiple histograms.
3949

4050
```{r}
4151
lines <- "data {

0 commit comments

Comments
 (0)