check_pkg: Check a package documentation and DESCRIPTION file on...
In irudnyts/pkgspell: Spell checker for R packages development

Description Usage Arguments Details Value See Also

check_pkg checks a package for typos and spelling errors, including DESCRIPTION file (both Title: and Description:), as well as all .Rd files in folder /man.

1	check_pkg(pkg_dir = getwd())

pkg_dir

a character vector of length one, specifying the location of a package. The default value is the working directory (getwd). Missing value will be ignored.

The function's argument pkg_dir is the location of the package directory. By default it is the current working directory. The function runs two functions inside: check_desc and check_rd. If some files are missing, the function throw a warning and continue executing the rest of the code. Checks are done with a help of hunspell package.

A data.frame with columns: File, Line, Word. The File is either DESCRIPTION file, or the .R file, which generated .Rd file. Line is the number of the line, where the error appears, and Word is the word with error.

check_desc, check_rd

irudnyts/pkgspell documentation built on May 18, 2019, 5:49 a.m.