Skip to content

Commit 3b73160

Browse files
committed
feat(stroke): Clear out repository, and amend key files to be relevant to stroke (CITATION, DESCRIPTION, NEWS, README)
1 parent 2023d4f commit 3b73160

File tree

119 files changed

+247
-145109
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

119 files changed

+247
-145109
lines changed

CITATION.cff

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
cff-version: 1.2.0
55
title: >-
6-
R DES RAP Template
6+
Stroke capacity planning model: R DES RAP
77
message: >-
88
If you use this software, please cite it using the
99
metadata from this file.
@@ -15,9 +15,9 @@ authors:
1515
affiliation: University of Exeter
1616
orcid: 'https://orcid.org/0000-0002-6596-3479'
1717
repository-code: >-
18-
https://github.com/pythonhealthdatascience/rdesrap_mms
18+
https://github.com/pythonhealthdatascience/rdesrap_stroke
1919
abstract: >-
20-
A template for creating discrete-event simulation (DES) models in R
21-
within a reproducible analytical pipeline (RAP).
22-
version: 0.4.0
23-
date-released: '2025-06-04'
20+
Reproducible analytical pipeline (RAP) for R discrete-event simulation (DES)
21+
implementing the Stroke Capacity Planning Model from Monks et al. 2016.
22+
version: 0.1.0
23+
date-released: '2025-06-30'

DESCRIPTION

Lines changed: 6 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -9,36 +9,17 @@ Authors@R: c(
99
role = c("aut", "cre")
1010
)
1111
)
12-
URL: https://github.com/pythonhealthdatascience/rdesrap_mms
13-
Description: Template reproducible analytical pipeline (RAP) for simple R
14-
discrete-event simulation (DES) model.
12+
URL: https://github.com/pythonhealthdatascience/rdesrap_stroke
13+
Description: Reproducible analytical pipeline (RAP) for R discrete-event
14+
simulation (DES) implementing the Stroke Capacity Planning Model from Monks
15+
et al. 2016.
1516
License: MIT + file LICENSE
1617
Encoding: UTF-8
1718
LazyData: true
1819
RoxygenNote: 7.3.2
1920
Imports:
20-
simmer,
21-
magrittr,
22-
dplyr,
23-
purrr,
24-
rlang,
25-
tidyr,
26-
tidyselect,
27-
future,
28-
future.apply,
29-
ggplot2,
30-
tibble,
31-
gridExtra,
32-
R6
21+
simmer
3322
Suggests:
3423
testthat (>= 3.0.0),
35-
patrick,
36-
lintr,
37-
devtools,
38-
xtable,
39-
data.table,
40-
mockery,
41-
fitdistrplus,
42-
lubridate,
43-
plotly
24+
lintr
4425
Config/testthat/edition: 3

NAMESPACE

Lines changed: 0 additions & 83 deletions
This file was deleted.

NEWS.md

Lines changed: 2 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,4 @@
1-
# R DES RAP Template 0.4.0
21

3-
Major changes include: addition of two new metrics (queue length and patients in service); input modelling; and synthetic data. Also, enabled solutions below the defined initial replications for the replications algorithm.
2+
# Stroke capacity planning model: R DES RAP 0.1.0
43

5-
## New features
6-
7-
* Add synthetic data and explanation in `README`.
8-
* Add `input_modelling.Rmd`.
9-
* Add unit tests for `find_position()`.
10-
* Add mock paper with figures mentioned in `.Rmd`/`README`.
11-
* Add `CITATION`.
12-
* Add printing of parameters when running model.
13-
* Add two new metrics: queue length and patients in service.
14-
15-
## Bug fixes
16-
17-
* Add `find_position()` which allows us to find a solution below the initial replications set when using `ReplicationsAlgorithm`.
18-
19-
## Other changes
20-
21-
* Changed desired precision when choosing replications to 0.1.
22-
* Made `README` simpler/clearer, so it focuses on describing the repository, rather than on being a template.
23-
* Add `fitdistrplus`, `lubridate` and `plotly`, and updated some packages.
24-
* Set `renv` snapshot type to implicit (was previously all).
25-
* In `choosing_cores.Rmd`, set `devtools::install(upgrade = "never")` (else would try to update packages).
26-
* GitHub action runs tests on latest mac, windows and ubuntu (but not on development or old ubuntu anymore).
27-
28-
# R DES RAP Template 0.3.0
29-
30-
Major changes include addition of functions/classes for choosing the warm-up length and number of replications. Other changes include tests, possibility to override seeds in runner, a bug fix for the mean wait time and serve length, code refactoring, and others.
31-
32-
## New features
33-
34-
* Add file explaining how `set_attributes()` changes results (`using_set_attributes.Rmd`).
35-
* Add functions for choosing warm-up length (`choose_warmup`) and an example file (`choosing_warmup.Rmd`).
36-
* Add some extra checks in functional tests using the unseen metrics.
37-
* Add classes/functions for automated choice of the number of replications (`choose_replications.R`) and an example file explaining these (`choosing_replications.Rmd`), along with tests for these (`test-backtest-replications.R`, `test-functionaltest-replications.R`, `test-unittest-replications.R`).
38-
* Add options in `runner()` to override future.seed and use the run numbers as seeds (allowing consistency with `model()`) (and add test using it).
39-
* Add unit test for parallel processing.
40-
41-
## Bug fixes
42-
43-
* Corrected calculation of mean wait and serve length (previously dropped all arrivals NA for `end_time` - now bases on `wait_time`, and so includes people who are midway through appointment at end of simulation).
44-
45-
## Other changes
46-
47-
* Split calculations from `get_run_results()` into seperate functions for simplicity, and to make them reusable for other purposes.
48-
* Simplified calculation of utilisation (same output, simpler code).
49-
* Add example of calculating overall results table to `analysis.Rmd`.
50-
* Add "how does model work" and "acknowledgements" sections to README.
51-
52-
# R DES RAP Template 0.2.0
53-
54-
Warm-up period, "unseen" metrics and tests. Note that the alteration to record service duration altered the order of random number generation, so results now differ from before.
55-
56-
## New features
57-
58-
* Add warm-up period (`filter_warmup()`).
59-
* Add measurement of when service starts and its duration during the model run (`set_attribute("nurse_serve_start", ...` and `set_attribute("nurse_serve_length", ...`).
60-
* Add count and wait time for unseen patients in the run results.
61-
* Add tests for warm-up, unseen metrics, and logs.
62-
* Add `arrivals` and `resources` to base case back test.
63-
64-
## Bug fixes
65-
66-
* Include all patients in the run results `arrivals` count (and not only those who completed the service).
67-
* Include patients partway through service in the `mean_waiting_time` and `mean_service_time` (and not only those who completed the service).
68-
* Use `devtools::install()` in `choosing_cores.Rmd` (required to get updated package for parallel processing).
69-
70-
## Other changes
71-
72-
* Simplify scenario back test.
73-
* Add DOI and Zenodo citation to README.
74-
75-
# R DES RAP Template 0.1.0
76-
77-
🌱 First release of the R DES template.
4+
🌱 First release of the R stroke model.

0 commit comments

Comments
 (0)