Skip to content

Commit 6e8b4e3

Browse files
committed
style(accessibility): finish adding alt text (#186)
1 parent b63597e commit 6e8b4e3

File tree

14 files changed

+43
-43
lines changed

14 files changed

+43
-43
lines changed

pages/example_models/example_models.qmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ This model simulates a clinic where patients arrive randomly, wait to see a nurs
3131

3232
<br>
3333

34-
![](examples_resources/nurse_des.drawio.png)
34+
![](examples_resources/nurse_des.drawio.png){fig-alt="DAG for nurse visit simulation"}
3535

3636
#### Model summary
3737

@@ -116,7 +116,7 @@ In this book, based on the published description of the model's logic and parame
116116

117117
<br>
118118

119-
![](examples_resources/stroke_rehab_design.png)
119+
![](examples_resources/stroke_rehab_design.png){fig-alt="DAG for stroke pathway simulation."}
120120

121121
#### Model summary
122122

pages/guide/inputs/input_data.qmd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ When managing input data in your RAP, there are three key files:
2929
* **Input modelling code:** Code/scripts used to estimate parameters or fit distributions.
3030
* **Parameters:** Numerical values used by your model (e.g., arrival rates, service times).
3131

32-
![](input_data_resources/input_files.png)
32+
![](input_data_resources/input_files.png){fig-alt="Illustration of raw data, which is fed to input modelling code, which is the basis of the chosen parameters."}
3333

3434
## What is included in a RAP?
3535

@@ -42,7 +42,7 @@ In other words, a complete RAP covers the journey from version-controlled input
4242

4343
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:
4444

45-
![](input_data_resources/input_rap.png)
45+
![](input_data_resources/input_rap.png){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)."}
4646

4747
> **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.
4848
@@ -80,7 +80,7 @@ The way you might set up private and public repositories depends on whether you
8080
2. Copy the resulting real parameter files to the public repository.
8181
3. Run your model and share code/results publicly - users can fully reproduce your analysis using the real parameters.
8282

83-
![](input_modelling_resources/scenario1.drawio.png)
83+
![](input_modelling_resources/scenario1.drawio.png){fig-alt="Flow diagram for scenario 1."}
8484

8585
### Scenario 2: Only sharing fake/synthetic parameters
8686

@@ -96,7 +96,7 @@ The way you might set up private and public repositories depends on whether you
9696
3. Use the shared simulation package in both repositories.
9797
4. Run and share the full workflow in public with synthetic parameters; run the actual analysis in private with the real parameters.
9898

99-
![](input_modelling_resources/scenario2.drawio.png)
99+
![](input_modelling_resources/scenario2.drawio.png){fig-alt="Flow diagram for scenario 2."}
100100

101101
:::
102102

pages/guide/output_analysis/length_warmup.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Many different methods have been proposed for **determining a suitable length of
8282

8383
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).
8484

85-
![](length_warmup_resources/warmup.png){width=75% fig-align="center"}
85+
![](length_warmup_resources/warmup.png){width=75% fig-align="center" fig-alt="Illustrative graph of steady-state behaviour."}
8686

8787
When determining your warm-up period, you should:
8888

pages/guide/output_analysis/n_reps.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Then, run your simulation for an **increasing number of replications**. At first
9191

9292
<br>
9393

94-
![](n_reps_resources/nreps_graph.png){fig-align="center"}
94+
![](n_reps_resources/nreps_graph.png){fig-align="center" fig-alt="Illustrative graph showing confidence interval becoming stable and narrow."}
9595

9696
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.
9797

pages/guide/output_analysis/parallel.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Normally, when you run a program, it only uses one core, so only one worker is d
8787

8888
**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**.
8989

90-
![](parallel_resources/parallel.drawio.png){fig-align="center" width=75%}
90+
![](parallel_resources/parallel.drawio.png){fig-align="center" width=75% fig-alt="Illustration of sequential v.s. parallel runs."}
9191

9292
## How to add parallel processing
9393

pages/guide/output_analysis/warmup.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ library(simmer)
5454

5555
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.
5656

57-
![](warmup_resources/initialisation_bias.png)
57+
![](warmup_resources/initialisation_bias.png){fig-alt="Illustration showing an empty hospital simulation model v.s. busy hospital in reality."}
5858

5959
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:
6060

pages/guide/sharing/archive.qmd

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -159,13 +159,13 @@ This tutorial shows how to archive a GitHub repository using Zenodo, chosen for
159159

160160
**1. Login to Zenodo**. Go to <https://zenodo.org/login/>, and login or sign-up to Zenodo with your **GitHub account**.
161161

162-
![](archive_resources/zenodo_login.png){fig-align="center"}
162+
![](archive_resources/zenodo_login.png){fig-align="center" fig-alt="Screenshot of Zenodo login page."}
163163

164164
<br>
165165

166166
**2. Go to Zenodo GitHub page**. Click on the arrow in the top right corner, and select "GitHub".
167167

168-
![](archive_resources/zenodo_menu.png){fig-align="center"}
168+
![](archive_resources/zenodo_menu.png){fig-align="center" fig-alt="Screenshot of Zenodo menu."}
169169

170170
<br>
171171

@@ -198,13 +198,13 @@ This tutorial shows how to archive a GitHub repository using Zenodo, chosen for
198198

199199
**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:
200200

201-
![](archive_resources/book_zenodo_releases.png){fig-align="center"}
201+
![](archive_resources/book_zenodo_releases.png){fig-align="center" fig-alt="Screenshot of Zenodo entry linked to GitHub release."}
202202

203203
<br>
204204

205205
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:
206206

207-
![](archive_resources/book_zenodo_page.png){fig-align="center"}
207+
![](archive_resources/book_zenodo_page.png){fig-align="center" fig-alt="Screenshot of Zenodo entry."}
208208

209209
### Zenodo communities
210210

@@ -214,19 +214,19 @@ To set-up a community, visit <https://zenodo.org/communities> and select &nbsp;[
214214

215215
Once your community is set up, go to your Zenodo record/s and scroll down to "Communities", then click "+ Submit to community".
216216

217-
![](archive_resources/zenodo_submit_community.png){fig-align="center"}
217+
![](archive_resources/zenodo_submit_community.png){fig-align="center" fig-alt="Screenshot of Zenodo 'Submit to community' button."}
218218

219219
<br>
220220

221221
Search for your community, give appropriate permissions, and submit.
222222

223-
![](archive_resources/zenodo_submit_community_2.png){fig-align="center"}
223+
![](archive_resources/zenodo_submit_community_2.png){fig-align="center" fig-alt="Screenshot of Zenodo 'Submit to community' pop-up."}
224224

225225
<br>
226226

227227
From the "Requests" tab of your community dashboard, you can then accept this submission to add it to the community.
228228

229-
![](archive_resources/zenodo_community_requests.png){fig-align="center"}
229+
![](archive_resources/zenodo_community_requests.png){fig-align="center" fig-alt="Screenshot of Zenodo community requests page."}
230230

231231
## Explore the example models
232232

pages/guide/sharing/changelog.qmd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -185,19 +185,19 @@ GitHub releases can be used to easily archive work to Zenodo - see the [Sharing
185185

186186
3. In the right sidebar under "Releases", click **Create a new release**
187187

188-
![](changelog_resources/create_release.png)
188+
![](changelog_resources/create_release.png){fig-alt="Screenshot of GitHub repository with cursor hovering over 'Create a new release'."}
189189

190190
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 &nbsp;[Publish release]{style="background: #597341; color: #fff; border-radius:4px; padding:2px 8px; font-family:monospace; font-weight:bold; font-size:90%;"}&nbsp;. For example:
191191

192-
![](changelog_resources/release.png)
192+
![](changelog_resources/release.png){fig-alt="Screenshot of GitHub new release page."}
193193

194194
## Using GitHub commits when writing a changelog
195195

196196
When writing a changelog, it is helpful to **look over your GitHub commits** to remember recent changes.
197197

198198
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:
199199

200-
![](changelog_resources/changes_since_release.png)
200+
![](changelog_resources/changes_since_release.png){fig-alt="Screenshot of GitHub release with cursor hovering over 'X commits to main since this release'."}
201201

202202
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.
203203

pages/guide/sharing/citation.qmd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This page explains why and how to provide citation instructions in your simulati
2525

2626
:::
2727

28-
![](citation_resources/citation.png)
28+
![](citation_resources/citation.png){fig-alt="Illustration representing citation and ORCID."}
2929

3030
## Why provide citation information?
3131

@@ -69,7 +69,7 @@ A `CITATION.cff` file is a plain text file with a standard structure to share ci
6969

7070
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.
7171

72-
![](citation_resources/cffinit.png)
72+
![](citation_resources/cffinit.png){fig-alt="Screenshot of cffinit."}
7373

7474
As an example, the `CITATION.cff` from the repository for this book:
7575

@@ -87,7 +87,7 @@ As an example, the `CITATION.cff` from the repository for this book:
8787

8888
* **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:
8989

90-
![](citation_resources/cff_github.png)
90+
![](citation_resources/cff_github.png){fig-alt="Screenshot of GitHub 'Cite this repository'."}
9191

9292
### `README.md`
9393

@@ -219,7 +219,7 @@ The [cffr](https://github.com/ropensci/cffr) package can be handy if you are mai
219219

220220
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/>.
221221

222-
![Example: ORCID profile for Amy Heather](citation_resources/orcid_profile.png)
222+
![Example: ORCID profile for Amy Heather](citation_resources/orcid_profile.png){fig-alt="Screenshot of example ORCID profile."}
223223

224224
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.
225225

pages/guide/sharing/licence.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ For helping choosing an appropriate licence:
8787

8888
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.
8989

90-
![](licence_resources/github_licence.png)
90+
![](licence_resources/github_licence.png){fig-alt="Screenshot of GitHub 'Add license' option."}
9191

9292
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.
9393

0 commit comments

Comments
 (0)