|
| 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) |
0 commit comments