stan-dev / stan-dev/projpred

Alt text for vignettes

Open
#526 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
R
Stars
114
Forks
31
PR merge metrics
No merged PRs in 30d

Description

When building the pkgdown site, the following notes are shown:

Reading vignettes/latent.Rmd
Writing articles/latent.html
# [...]
✖ Missing alt-text in vignettes/latent.Rmd
• latent_files/figure-html/plot_vsel_lat-1.png
• latent_files/figure-html/post_vs_trad-1.png
• latent_files/figure-html/plot_vsel_nebin-1.png
ℹ Learn more in `vignette(pkgdown::accessibility)`.
Reading vignettes/projpred.Rmd
Writing articles/projpred.html
✖ Missing alt-text in vignettes/projpred.Rmd
• projpred_files/figure-html/plot_vsel_fast-1.png
• projpred_files/figure-html/plot_vsel_fast_refit-1.png
• projpred_files/figure-html/plot_vsel-1.png
• projpred_files/figure-html/plot_cv_proportions-1.png
• projpred_files/figure-html/plot_cv_proportions_cumul-1.png
• projpred_files/figure-html/bayesplot_prj-1.png
• projpred_files/figure-html/bayesplot_ref-1.png
• projpred_files/figure-html/proj_predict-1.png
ℹ Learn more in `vignette(pkgdown::accessibility)`.

I'm currently lacking the time to add alt text, but we should do this in the future.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open vignettes/latent.Rmd and vignettes/projpred.Rmd and inspect the figures listed in the pkgdown warnings. Read the guidance in pkgdown::accessibility before adding descriptions, then rebuild the pkgdown site. Done means the listed missing-alt-text warnings no longer appear.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
accessibility, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.