Skip to content

Commit 09e1c31

Browse files
committed
docs(frameworks/hsma): cleared responses from heather_2025.md and nhs_rap.md, and deleted hsma_changes.md
1 parent 9ccdb87 commit 09e1c31

File tree

3 files changed

+37
-394
lines changed

3 files changed

+37
-394
lines changed

docs/heather_2025.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,32 @@ As part of the project STARS (Sharing Tools and Artefacts for Reproducible Simul
77
| Recommendation | Completion | Further details |
88
| - | - | - |
99
| **Set-up** |
10-
| Share code with an open licence (⭐) | | `LICENSE` |
11-
| Link publication to a specific version of the code | N/A | No publication. |
12-
| List dependencies and versions | | `environment.yaml` |
10+
| Share code with an open licence (⭐) | | |
11+
| Link publication to a specific version of the code | | |
12+
| List dependencies and versions | | |
1313
| **Running the model** |
14-
| Provide code for all scenarios and sensitivity analyses (⭐) | | Within `analysis.ipynb` |
15-
| Ensure model parameters are correct (⭐) | | - |
16-
| Control randomness | | - |
14+
| Provide code for all scenarios and sensitivity analyses (⭐) | | |
15+
| Ensure model parameters are correct (⭐) | | |
16+
| Control randomness | | |
1717
| **Outputs** |
18-
| Include code to calculate all required model outputs (⭐) | | - |
19-
| Include code to generate the tables, figures, and other reported results (⭐) | | Includes some examples (in `analysis.ipynb`) where these are generated. |
18+
| Include code to calculate all required model outputs (⭐) | | |
19+
| Include code to generate the tables, figures, and other reported results (⭐) | | |
2020

2121
## Recommendations to support troubleshooting and reuse
2222

2323
| Recommendation | Completion | Further details |
2424
| - | - | - |
2525
| **Design** |
26-
| Separate model code from applications | | - |
27-
| Avoid hard-coded parameters | | - |
28-
| Minimise code duplication | | - |
26+
| Separate model code from applications | | |
27+
| Avoid hard-coded parameters | | |
28+
| Minimise code duplication | | |
2929
| **Clarity** |
30-
| Comment sufficiently | | - |
31-
| Ensure clarity and consistency in the model results tables | | - |
32-
| Include run instructions | | - |
33-
| State run times and machine specifications | | In `README.md` and `.ipynb` files. |
30+
| Comment sufficiently | | |
31+
| Ensure clarity and consistency in the model results tables | | |
32+
| Include run instructions | |
33+
| State run times and machine specifications | | |
3434
| **Functionality** |
35-
| Optimise model run time | | Provides option of parallel processing. |
36-
| Save outputs to a file | | Includes some examples (in `analysis.ipynb`) where outputs are saved. |
37-
| Avoid excessive output files | | - |
38-
| Address large file sizes | | Includes an example (in `analysis.ipynb`) where patient results are not saved as large but unnecessary - but notes how these could be compressed when saving to file (`.csv.gz`). |
35+
| Optimise model run time | | |
36+
| Save outputs to a file | | |
37+
| Avoid excessive output files | | |
38+
| Address large file sizes | | |

0 commit comments

Comments
 (0)