check_spelling: Spell check a package or project

In inbo/checklist: A Thorough and Strict Set of Checks for R Packages and Source Code

Spell check a package or project

Description

This function checks by default any markdown (.md) or Rmarkdown (.Rmd) file found within the project. It also checks any R help file (.Rd) in the man folder. Use the set_exceptions() method of the checklist object to exclude files or use a different language. Have a look at vignette("spelling", package = "checklist") for more details.

Usage

check_spelling(x = ".", quiet = FALSE)

Arguments

x	Either a checklist object or a path to the source code. Defaults to ..
quiet	Whether to print check output during checking.

See Also

Other both: add_badges(), check_filename(), check_lintr(), custom_dictionary(), default_organisation(), print.checklist_spelling(), read_checklist(), read_organisation(), update_citation(), write_checklist(), write_citation_cff(), write_organisation(), write_zenodo_json()

inbo/checklist documentation built on June 15, 2025, 12:54 p.m.