You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/heather_2025.md
+19-19Lines changed: 19 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,32 +7,32 @@ As part of the project STARS (Sharing Tools and Artefacts for Reproducible Simul
7
7
| Recommendation | Completion | Further details |
8
8
| - | - | - |
9
9
|**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 |||
13
13
|**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 |||
17
17
|**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 (⭐) |||
20
20
21
21
## Recommendations to support troubleshooting and reuse
22
22
23
23
| Recommendation | Completion | Further details |
24
24
| - | - | - |
25
25
|**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 |||
29
29
|**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 |||
34
34
|**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`).|
0 commit comments