Skip to content

Commit 375d793

Browse files
authored
Checklist for new submissions (#206)
1 parent bc0f8fd commit 375d793

3 files changed

Lines changed: 23 additions & 14 deletions

File tree

.github/PULL_REQUEST_TEMPLATE/new_petab_problem.md

Lines changed: 0 additions & 14 deletions
This file was deleted.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
**Checklist for the submission of new PEtab problems**
2+
- [ ] The PEtab problem is based on a model that is peer-reviewed and published
3+
- [ ] The problem ID is in the format `{LAST_NAME_OF_FIRST_AUTHOR}_{ABBREVIATED_JOURNAL_NAME}{YEAR_OF_PUBLICATION}`
4+
- [ ] The problem ID is in the pull request title
5+
- [ ] There is a GitHub issue for this problem
6+
- [ ] The problem ID is in the issue title
7+
- [ ] A brief model description (one or two sentences)
8+
- [ ] A brief data description (one or two sentences)
9+
- [ ] The issue and PR are linked to each other
10+
- [ ] Differences between the implementation and the original publication are described
11+
- [ ] Experience of fitting / uncertainty analysis (e.g. optimizer used, hyperparameters, reproducibility of best fit)
12+
- [ ] Source of nominal parameters (e.g.: taken from the original publication, or from your own fitting)
13+
- [ ] The SBML file
14+
- [ ] Annotation with reference to the original publication ([example](https://github.com/Benchmarking-Initiative/Benchmark-Models-PEtab/blob/3154d27edbfc4eb19b768465945bc81381a7c964/Benchmark-Models/Rahman_MBS2016/model_Rahman_MBS2016.xml#L4-L14))
15+
- [ ] The model ID and model name attributes in the SBML model file match the problem name ([example](https://github.com/Benchmarking-Initiative/Benchmark-Models-PEtab/blob/3154d27edbfc4eb19b768465945bc81381a7c964/Benchmark-Models/Rahman_MBS2016/model_Rahman_MBS2016.xml#L3))
16+
- [ ] PEtab files
17+
- [ ] A "simulated data" measurement table is included, using the nominal parameters
18+
- [ ] A visualization table is included, that can be used with the simulate data to reproduce figures from the original publication
19+
- [ ] The PEtab problem is valid (check with e.g. `petablint -vy problem.yaml`)
20+
- [ ] The PEtab problem author(s) are assigned to the GitHub issue
21+
- [ ] The README has been updated with `python scripts/overview.py --update`
22+
- [ ] The new PEtab problem row in the generated table has the correct reference (and other entries)

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
New submissions are very welcome! Please check our [pull request template](.github/PULL_REQUEST_TEMPLATE/pull_request_template.md) for guidelines.

0 commit comments

Comments
 (0)