use_spell_check

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

Automate package and project setup tasks that are otherwise
performed manually. This includes setting up unit testing, test
coverage, continuous integration, Git, 'GitHub', licenses, 'Rcpp',
'RStudio' projects, and more.

Jennifer Bryan

usethis

Automate Package and Project Setup

Hadley Wickham

Malcolm Barrett

Andy Teucher

Posit Software, PBC 

use_spell_check function

<dl><dt>vignettes</dt>
<dd>Logical, <code>TRUE</code> to spell check all <code>rmd</code> and <code>rnw</code> files in
the <code>vignettes/</code> folder.</dd>
<dt>lang</dt>
<dd>Preferred spelling language. Usually either <code>"en-US"</code> or
<code>"en-GB"</code>.</dd>
<dt>error</dt>
<dd>Logical, indicating whether the unit test should fail if
spelling errors are found. Defaults to <code>FALSE</code>, which does not error, but
prints potential spelling errors</dd></dl>

Arguments

Use spell check — use_spell_check

<dl>

<dt>vignettes</dt>
<dd>Logical, <code>TRUE</code> to spell check all <code>rmd</code> and <code>rnw</code> files in
the <code>vignettes/</code> folder.</dd>


<dt>lang</dt>
<dd>Preferred spelling language. Usually either <code>"en-US"</code> or
<code>"en-GB"</code>.</dd>


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

</dl>

use_spell_check: Use spell check

Description

Usage

Arguments