Package 'altcheckr'

Check for Problems with the Alt Text for Images on a Web Page

Description

Infer whether an image's alt tag is missing or could be improved.

Usage

alt_check(
  attributes_df,
  max_char = 125,
  min_char = 20,
  file_ext = ".jpg$|.jpeg$|.png$|.svg$|.gif$",
  redundant_pattern = "image|picture|photo|graph|plot|diagram"
)

Arguments

attributes_df	A data.frame/tibble with image attributes, produced by alt_get.
max_char	A numeric value. Alt text longer than this is flagged.
min_char	A numeric value. Alt text shorter than this is flagged.
file_ext	A character string. A regular expression of image file extensions.
redundant_pattern	A character string. A regular expression of 'redundant' phrases in alt text.

Value

A tibble object with classes tbl_df, tbl and data.frame. In addition to columns provided by alt_get, also returns:

• alt_exists "Exists", "Missing" or intentionally "Empty".

• nchar_count Integer. Number of characters.

• nchar_assess "Short", "Long" or "OK", depending on inputs to min_char and max_char.

• file_ext Logical. Does it look like the alt text might just be a filename (e.g. ends with ".jpg")?

• self_evident Logical. Is a redundant phrase used in the alt text (e.g. "a picture of")?

• terminal_punct Logical. Does the alt text end with terminal punctuation, like a period, to allow a screen reader to parse it as a sentence?

• spellcheck Character. Words to check for misspelling. These could be misread by a screenreader.

• not_basic Character list column. Words that match to the 850 words of Charles Kay Ogden's Basic English.

Examples

## Not run: 
    url <- "https://alphagov.github.io/accessibility-tool-audit/test-cases.html#images"
    attr_df <- alt_get(url)
    alt_check(attr_df)
    
## End(Not run)

---

Get HTML Attributes from the Image Elements of a Web Page

Description

Scrape (politely) a web page's HTML and extract the attributes from each image element (<img>) on that page.

Usage

alt_get(webpage, all_attributes = FALSE)

Arguments

webpage	A character string describing the URL of a webpage. Must be a full path including https://www. where appropriate.
all_attributes	Logical. Do you want to return all the image attributes as columns or just src, alt and longdesc (if it exists)?

Value

A tibble object with classes tbl_df, tbl and data.frame. One row per image element and one column per attribute, unless (all_attributes = FALSE), which returns only:

• src The source of the image as a filepath.

• alt The alternative (alt) text for the image.

• longdesc The path to a file that contains a longer description for complex images (only returned if present).

Examples

## Not run: 
    test_url <- "https://www.bbc.co.uk/news"
    alt_get(webpage = test_url)
    
## End(Not run)

---

Example of alt_get() Output

Description

A dummy data frame to mimic output from alt_get.

Usage

example_get

Format

A data frame with 11 rows and 2 variables:

src

a fake image source

alt

dummy alt text with different types of problems

...

---