check_spelling: Check spelling of all md, rmd, and qmd files

In ottrpal: Companion Tools for Open-Source Tools for Training Resources (OTTR)

Check spelling of all md, rmd, and qmd files

Description

Check spelling of all md, rmd, and qmd files

Usage

check_spelling(
  path = ".",
  output_dir = "check_reports",
  resources_dir = "resources",
  file_pattern = "md$"
)

Arguments

path	path to the bookdown or quarto course repository, must have a '.github' folder which will be used to establish the top of the repo.
output_dir	A relative file path to the folder (existing or not) that the output check file should be saved to. Default is "check_reports"
resources_dir	A relative file path to the folder (existing or not) that the dictionary.txt file and exclude_files.txt will be found. Default is "resources". If no dictionary.txt file and exclude_files.txt files are found, we will download one.
file_pattern	A file pattern should we be looking for for the files whose spelling should be tested. Default is "md$". Regex interpreted.

Value

A file will be saved that lists the broken URLs will be saved to the specified output_dir.

Examples

## Not run: 

rmd_dir <- setup_ottr_template(dir = ".", type = "rmd", render = FALSE)

check_spelling(rmd_dir)

# If there are broken URLs they will be printed in a list at "check_reports/url_checks.tsv"

qmd_dir <- setup_ottr_template(dir = ".", type = "quarto", render = FALSE)

check_spelling(qmd_dir)

## End(Not run)

ottrpal documentation built on April 3, 2025, 7:46 p.m.