thomasp85/ggraph

[Accessibility] Vignette plots lack alt= attributes

Open

#340 opened on Feb 8, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)R (114 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (1,115 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

We have a tool that flags images that lack an alt= attribute. See https://help.siteimprove.com/support/solutions/articles/80000863904-accessibility-image-alt-text-best-practices -- these are essential for conveying the image contents to users on screen readers.

You can add these to your vignettes by using the recent-ish fig.alt chunk option in knitr; see https://www.rstudio.com/blog/knitr-fig-alt/.

There are a lot of issues, so I'll just name the vignettes:

  • Edges
  • Layouts
  • Nodes
  • tidygraph

If you'd like more details I can provide, but I'm assuming it's basically clear enough what plots are at issue.

Contributor guide

Research direction
Add `fig.alt` chunk option to each vignette's image chunks in the Rmd files to provide descriptive alt text for accessibility.
Tech stack
r
Domain
documentationaccessibility
Issue type
Accessibility
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
R
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85