[Accessibility issue] Vignettes lacks alt= in plots
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 588
- Forks
- 71
- Avg merge
- 1h 58m
- Merged PRs (30d)
- 1
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/.
The vignette at issue is https://github.com/tidyverts/fable/blob/79d5a5049a24ea55dd5d8009259b8ebcea8a4e98/vignettes/fable.Rmd.
Unfortunately the lines are flagged in the HTML output, which won't correspond exactly to the .Rmd file lines, but I assume if you're familiar with the vignette it will be clear which images need it:
fable/inst/doc/fable.html:378
fable/inst/doc/fable.html:579
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open vignettes/fable.Rmd and compare its generated output with the flagged locations fable/inst/doc/fable.html:378 and :579. Read the knitr fig.alt guidance, identify the corresponding plot chunks, and add meaningful alt text so the generated HTML images no longer lack alt attributes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- accessibility, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100