1% Generated by roxygen2: do not edit by hand 2% Please edit documentation in R/spell-check.R 3\name{spell_check} 4\alias{spell_check} 5\title{Spell checking} 6\usage{ 7spell_check(pkg = ".", vignettes = TRUE, use_wordlist = TRUE) 8} 9\arguments{ 10\item{pkg}{The package to use, can be a file path to the package or a 11package object. See \code{\link[=as.package]{as.package()}} for more information.} 12 13\item{vignettes}{also check all \code{rmd} and \code{rnw} files in the pkg \code{vignettes} folder} 14 15\item{use_wordlist}{ignore words in the package \link[spelling:wordlist]{WORDLIST} file} 16} 17\description{ 18Runs a spell check on text fields in the package description file, manual 19pages, and optionally vignettes. Wraps the \link[spelling:spell_check_package]{spelling} 20package. 21} 22