Learn R Programming

accessrmd (version 1.0.0)

Improving the Accessibility of 'rmarkdown' Documents

Description

Provides a simple method to improve the accessibility of 'rmarkdown' documents. The package provides functions for creating or modifying 'rmarkdown' documents, resolving known errors and alerts that result in accessibility issues for screen reader users.

Copy Link

Version

Install

install.packages('accessrmd')

Monthly Downloads

267

Version

1.0.0

License

MIT + file LICENSE

Maintainer

Rich Leyshon

Last Published

May 3rd, 2022

Functions in accessrmd (1.0.0)

access_rmd

Produce an accessible Rmarkdown file template.
access_img

Produce an accessible image or chart.
check_compat

Checks if the html doctype is compatible.
find_all_tags

Find any markdown or HTML syntax tags within read lines.
detect_html_lang

Searches a file for valid methods of setting HTML lang attribute.
find_theme

Searches YAML head for YAML theme parameters, returning the theme if found.
check_urls

Check an Rmarkdown for broken links.
assemble_header

Assemble HTML header output from text provided.
access_head

Convert YAML to an accessible header
find_alt_lim

Find alt length limit for specific lang values.
retrieve_rmds

Find Rmd files within a provided file structure.
insert_yaml

Insert the required code for the specified toc type.
handle_rmd_path

Check rmd path & file type.
sus_alt

Check an R markdown document for suspicious alt text.
tags

return_heading

Return a HTML p tag formatted to resemble a heading tag.