use_spell_check

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

vignettes

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

lang

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

error

Adds a unit test to automatically run a spell check on documentation and,
optionally, vignettes during <code>R CMD check</code>, using the
<a rd-options="spelling:spell_check_package" href="/link/spelling?package=usethis&version=1.5.0&to=spelling%3Aspell_check_package" data-mini-rdoc="spelling:spell_check_package::spelling">spelling</a> package. Also adds a <code>WORDLIST</code>
file to the package, which is a dictionary of whitelisted words. See
<a rd-options="spelling:wordlist" href="/link/spelling%3A%3Awordlist?package=usethis&version=1.5.0&to=spelling%3Awordlist" data-mini-rdoc="spelling:wordlist::spelling::wordlist">spelling::wordlist</a> 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

RStudio 

use_spell_check function

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

use_spell_check: Use spell check

Description

Usage

Arguments