Skip to contents

Spell check a package or project

Source: R/check_spelling.R
check_spelling.Rd

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()