use_spell_check

0th

Percentile

Use spell check

Adds a unit test to automatically run a spell check on documentation and, optionally, vignettes during R CMD check, using the spelling package. Also adds a WORDLIST file to the package, which is a dictionary of whitelisted words. See spelling::wordlist for details.

Usage
use_spell_check(vignettes = TRUE, lang = "en-US", error = FALSE)
Arguments
vignettes

Logical, TRUE to spell check all rmd and rnw files in the vignettes/ folder.

lang

Preferred spelling language. Usually either "en-US" or "en-GB".

error

Logical, indicating whether the unit test should fail if spelling errors are found. Defaults to FALSE, which does not error, but prints potential spelling errors

Aliases
  • use_spell_check
Documentation reproduced from package usethis, version 1.5.1, License: GPL-3

Community examples

Looks like there are no examples yet.