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: index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
layout: home
3
3
---
4
4
5
-
# Biomedical Accessibility Workshop
5
+
# Assessing and Enhancing Digital Accessibility of Biological Data and Visualizations
6
6
7
7
## Background
8
8
As computational biologists, we produce biological datasets, visualizations, and computational tools. Our shared goal is to make our data and tools widely usable and accessible. However, we often fail to meet the needs of certain groups of people. Our recent [comprehensive accessibility evaluation](https://inscidar.org) shows that biological data resources are largely inaccessible to people with disabilities, with severe accessibility issues in almost 75% of all 3,112 data portals included in the study. To address the critical accessibility barriers, it is important to increase awareness of accessibility in the community and teach the workforce practical ways to enhance the accessibility of biological data resources. While there are existing resources and training opportunities that focus on content that includes no or little data, there is a lack of solutions and resources that provide insights into how to make data-intensive content accessible.
Copy file name to clipboardExpand all lines: sessions/4_notebooks.md
+49Lines changed: 49 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,3 +3,52 @@ layout: page
3
3
title: "Hands-on session 4: Making computational notebooks accessible"
4
4
permalink: /notebooks/
5
5
---
6
+
7
+
This session focusses on accessibility of computational notebooks. Computational notebooks are essential in computational biology. They are used to interact and present data. In this session, we focus on Jupyter Notebooks, as they are one of the most widely used type of notebooks, but these principles extend to other types of notebooks as well. As with other documents, notebooks should also be Perceivable, Operable, Understandable, and Robust.
8
+
9
+
## Notebooks used in this session
10
+
This session uses the following notebooks:
11
+
1. Notebook with guidelines [Google Colab](https://colab.research.google.com/drive/1n-kETLh2XHIgsxCG4tu2gdxVEjO7rjOy) and [download](../assets/notebooks/1-notebook-overview.ipynb)
12
+
2. Exercise on squidpy tutorial [Google Colab](https://colab.research.google.com/drive/1v9XcolBFJk_qiC32d9UALIkpV9vCr6e4) and [download](../assets/notebooks/2-squidpy-slideseqv2.ipynb)
13
+
14
+
15
+
## Current state of accessibility in notebooks
16
+
[Potluri et al., 2023](https://arxiv.org/pdf/2308.03241), assessed 100000 notebooks for accessibility, of which 92050 Python notebooks. We highlight a few findings:
17
+
- They found that 42.95% of notebooks have at least 1 programmatic figure, of which 99.81% do not have alt text. Of the 609 images with alt text, only 1 is generated with code, while the rest are added with markdown. Most of these alt texts are not useful (e.g., "image", "colab", "png"). So, most figures are not accessible through text.
18
+
- They found that 34.1% of notebooks had at least one table, so a vast majority of the notebooks do not display their data in a tabular way. Only 4.53% of notebooks had a table close to a figure, suggesting accompanying data with a figure. The average table has 15 rows and 140 columns, or 2100 cells.
19
+
- They found that 28.90% notebooks had a `<h1>` element in their first cell.
20
+
21
+
22
+
## How to make your notebooks accessible
23
+
Here, we focus on three themes to make your notebook more accessible:
24
+
- Navigability (landmarks, notebook size, links). This ensures a notebook is perceivable and operable. Someone needs to be able to navigate the notebook, e.g. by using proper headings.
25
+
- Data interpretability (figures, tables). This ensures a notebook is perceivable and understandble. By providing the data in manageable and annotated tables and providing alternative texts for figures, someone can explore the data patterns even without seeing these.
26
+
- Exporting (format, theme). Our main focus is on navigability and data interpretability, but we will also highlight how exporting a notebook can have a big impact on its accessibility.
27
+
28
+
29
+
## Checklist
30
+
As part of this tutorial, we provide the following checklist. This checklist does not guarentee full accessibility, but rather is meant to give a quick hands-on method to directly improve the accessibility of your notebooks.
31
+
32
+
1. Single `<h1>` element at the top of the notebook
33
+
2. First cell explains the background of the notebook
34
+
3. Rest of the notebook is structures with `<h2>` - `<h6>` elements
35
+
4. Markdown and code comments explain the notebook
36
+
5. Expected errors are marked
37
+
6. Links have a descriptive name
38
+
7. Table of the data is included
39
+
8. Tables have a caption
40
+
9. Tables have limited number of rows and columns
41
+
10. Static images have alt text
42
+
11. Dynamic images have alt text where possible
43
+
12. Notebook is not too long
44
+
13. An HTML version of the notebook is available if possible
45
+
46
+
47
+
## References
48
+
-[Project Notebooks For All](https://iota-school.github.io/notebooks-for-all/)
-[Repository MatplotAlt](https://github.com/make4all/matplotalt) and [documentation](https://matplotalt.readthedocs.io/en/latest/)
52
+
-[Paper of survey of notebook accessibility - Potluri et al., 2023](https://arxiv.org/pdf/2308.03241)
53
+
-[Slides of notebook best practises - Isabela Presedo-Floyd, 2023](https://docs.google.com/presentation/d/1LBcEOGhZfLXCaGAWUaGl4c6O5AXBBXzfoA9dV0W-5Pc/)
54
+
-[Tutorial for making Computational Notebooks accessible](https://create.uw.edu/a11y-in-action/accessible-courses/making-computational-notebooks-accessible/)
0 commit comments