Skip to content

Commit 712427b

Browse files
author
Bob Carpenter
committed
added guide to contributing new models
1 parent ef57b5a commit 712427b

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,21 @@ This repository holds open source Stan models, data simulators, and real data.
1616
- Basic Distributions
1717
- Basic Estimators
1818

19-
## Licensing
19+
## Organization
2020

21-
All of the example models are licensed to their author under new BSD license.
21+
Each example model should be organized to include the following
22+
23+
1. Stan program(s) implementing the model (and variants),
24+
2. program to simulate data (in R or Python),
25+
3. simulated data file itself (for now in .data.R dump format, later in JSON),
26+
4. summary of output fit for simulated data file (text),
27+
5. any real data sets with summary of fit (in original and Stan-readable format, with munging program from original to Stan-readable),
28+
6. citations to source for model and/or data,
29+
7. documentation needed to understand the model (LaTeX, text, or HTML), including discussion of parameterizations and/or optimizations and their relations to performance (and to each other if there are multiple models),
30+
8. keywords or other tags to help organize by category (e.g., from manual, from BUGS volume, from book, involving logistic regression, application area such as population model, model type such as IRT or mark-recapture, etc.)
31+
9. author/copyright-holder info and open-source license info if not new BSD.
32+
33+
34+
### Licensing
35+
36+
All of the example models are copyrighted by their author(s) or assignees under the new BSD license unless another open-source license is explicitly stipulated in the directory containing the model.

0 commit comments

Comments
 (0)