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: pages/guide/inputs/input_data.qmd
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ When managing input data in your RAP, there are three key files:
29
29
***Input modelling code:** Code/scripts used to estimate parameters or fit distributions.
30
30
***Parameters:** Numerical values used by your model (e.g., arrival rates, service times).
31
31
32
-

32
+
{fig-alt="Illustration of raw data, which is fed to input modelling code, which is the basis of the chosen parameters."}
33
33
34
34
## What is included in a RAP?
35
35
@@ -42,7 +42,7 @@ In other words, a complete RAP covers the journey from version-controlled input
42
42
43
43
Keep in mind that, especially in sensitive areas like healthcare, you may not be able to share your full RAP outside your team or organisation. Even so, it's crucial to **maintain a complete RAP internally** so your work remains fully reproducible. For example:
44
44
45
-

45
+
{fig-alt="Illustration showing that full internal RAP starts from raw data, but that RAP components shared publicly may start from later point (e.g., parameters)."}
46
46
47
47
> **Why is this important?** By starting at the source, you make your work transparent and easy to repeat. For instance, if new raw data becomes available, it's important you have your input modelling code so that you can check your distributions are still appropriate, re-estimate your model parameters, and re-run your analysis.
48
48
@@ -80,7 +80,7 @@ The way you might set up private and public repositories depends on whether you
80
80
2. Copy the resulting real parameter files to the public repository.
81
81
3. Run your model and share code/results publicly - users can fully reproduce your analysis using the real parameters.
Copy file name to clipboardExpand all lines: pages/guide/output_analysis/length_warmup.qmd
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -82,7 +82,7 @@ Many different methods have been proposed for **determining a suitable length of
82
82
83
83
We could plot mean results over time, but this would fluctuate too much. Instead, we plot the **cumulative mean** of the performance measures over time. We then look for the point where this **smoothes out and stabilises** - this indicates where your warm-up period should end (@Robinson2007).
{fig-align="center" fig-alt="Illustrative graph showing confidence interval becoming stable and narrow."}
95
95
96
96
When selecting the number of replications you should **repeat the analysis for all performance measures** and select the highest value as your number of replications.
Copy file name to clipboardExpand all lines: pages/guide/output_analysis/parallel.qmd
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -87,7 +87,7 @@ Normally, when you run a program, it only uses one core, so only one worker is d
87
87
88
88
**Parallel processing** means telling the computer to use more than one core at the same time. With more workers sharing the tasks, the work can be done **faster**.
Copy file name to clipboardExpand all lines: pages/guide/output_analysis/warmup.qmd
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -54,7 +54,7 @@ library(simmer)
54
54
55
55
For systems that naturally begin empty (like a clinic opening each morning), this is fine. However, for many systems that are usually already busy, such as an Accident and Emergency (A&E) department (also known as just an Emergency Department (ED)), starting empty skews the results at the beginning of a run. For example, making waiting times, queue lengths or resource use look lower than they would be in reality.
56
56
57
-

57
+
{fig-alt="Illustration showing an empty hospital simulation model v.s. busy hospital in reality."}
58
58
59
59
It is important to address this bias as part of your model experimentation validation (see [verification and validation](../verification_validation/verification_validation.qmd#experimentation-validation) page). There are two main strategies for addressing initialisation bias:
{fig-align="center" fig-alt="Screenshot of Zenodo menu."}
169
169
170
170
<br>
171
171
@@ -198,13 +198,13 @@ This tutorial shows how to archive a GitHub repository using Zenodo, chosen for
198
198
199
199
**6. View your Zenodo entry.** Click the repository name in Zenodo to view its releases, metadata, and related issues. If all goes well, you should see a new release and DOI listed - for example:
{fig-align="center" fig-alt="Screenshot of Zenodo entry linked to GitHub release."}
202
202
203
203
<br>
204
204
205
205
Clicking the DOI (for example: [10.5281/zenodo.17094156](https://doi.org/10.5281/zenodo.17094156)) opens the permanent archived version of our repository in Zenodo:
Copy file name to clipboardExpand all lines: pages/guide/sharing/changelog.qmd
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -185,19 +185,19 @@ GitHub releases can be used to easily archive work to Zenodo - see the [Sharing
185
185
186
186
3. In the right sidebar under "Releases", click **Create a new release**
187
187
188
-

188
+
{fig-alt="Screenshot of GitHub repository with cursor hovering over 'Create a new release'."}
189
189
190
190
On the new release page, enter a version tag (e.g., `v0.1.0`), copy in your release title and entry from the changelog, then click [Publish release]{style="background: #597341; color: #fff; border-radius:4px; padding:2px 8px; font-family:monospace; font-weight:bold; font-size:90%;"} . For example:
191
191
192
-

192
+
{fig-alt="Screenshot of GitHub new release page."}
193
193
194
194
## Using GitHub commits when writing a changelog
195
195
196
196
When writing a changelog, it is helpful to **look over your GitHub commits** to remember recent changes.
197
197
198
198
If you have already created some releases, click on your latest release on GitHub and then **X commits to main since this release** to see all recent commits:
{fig-alt="Screenshot of GitHub release with cursor hovering over 'X commits to main since this release'."}
201
201
202
202
You should aim to summarise the main updates in a human-readable way. While tiny details/tweaks don't need to be listed, **all notable changes** should be included in the changelog so it can serve as a reliable and comprehensive summary.
Copy file name to clipboardExpand all lines: pages/guide/sharing/citation.qmd
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ This page explains why and how to provide citation instructions in your simulati
25
25
26
26
:::
27
27
28
-

28
+
{fig-alt="Illustration representing citation and ORCID."}
29
29
30
30
## Why provide citation information?
31
31
@@ -69,7 +69,7 @@ A `CITATION.cff` file is a plain text file with a standard structure to share ci
69
69
70
70
The easiest way to create this file is using the [cffinit](https://citation-file-format.github.io/cff-initializer-javascript/#/) web application. It will guide you through the required information, and generate a `CITATION.cff` file at the end.
71
71
72
-

72
+
{fig-alt="Screenshot of cffinit."}
73
73
74
74
As an example, the `CITATION.cff` from the repository for this book:
75
75
@@ -87,7 +87,7 @@ As an example, the `CITATION.cff` from the repository for this book:
87
87
88
88
***GitHub:** Adds a "Cite this repository" button to the sidebar, which provides APA and BibTeX citations (based on the `CITATION.cff` file), and links to the file. For example:
89
89
90
-

90
+
{fig-alt="Screenshot of GitHub 'Cite this repository'."}
91
91
92
92
### `README.md`
93
93
@@ -219,7 +219,7 @@ The [cffr](https://github.com/ropensci/cffr) package can be handy if you are mai
219
219
220
220
An ORCID iD (Open Researcher and Contributor ID) is a unique persistent identifier for researchers and contributors. It **distinguishes** you from others with similar names and ensures your work is **correctly attributed** to you, even with name changes, different name formats, or moves between institutions. You can register for an iD at <https://orcid.org/>.
221
221
222
-

222
+
{fig-alt="Screenshot of example ORCID profile."}
223
223
224
224
You can then include the ORCID iDs of contributors to your project within your citation files (e.g. `CITATION.cff`) - and within your `README.md`. This ensures all contributors are uniquely and accurately identified, and links to their scholarly profiles.
Copy file name to clipboardExpand all lines: pages/guide/sharing/licence.qmd
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -87,7 +87,7 @@ For helping choosing an appropriate licence:
87
87
88
88
The easiest way to add a license is during GitHub repository set-up. Just use the **Add license** option, and Github will add the right `LICENSE` file for you.
89
89
90
-

90
+
{fig-alt="Screenshot of GitHub 'Add license' option."}
91
91
92
92
If you didn't add it then though, it's still very simple to add a license at any time. You just need to copy the license text from sites like <https://choosealicense.com/licenses/> or <https://opensource.org/licenses>, paste it into a new file called `LICENSE`, and commit it to your project.
0 commit comments