Opinionated Documentation Checking

High quality documentation can make for a great experience for your users. You can use 'docreview' to check that your R package documentation passes a number of configurable checks relating to documentation content.

docreview

An opinionated package for enhancing your R package documentation.

When writing R packages, high quality documentation can make for a great experience for your users.

You can use docreview to check that your R package documentation passes a number of checks:

• all exported functions should have documented examples of how to use them
• vignettes should not be too long
• vignettes should not be too complex

Installation

# Install the development version from GitHub:
# install.packages("devtools")
devtools::install_github("thisisnic/docreview")

Usage

library(docreview)
pkg_path <- system.file("testpkg", package = "docreview")
package_review(path = pkg_path)

See the vignette for more detailed usage guides.

Current default review checks

• Vignettes have no more than 2000 words (warn) or 3000 words (fail)
• Vignettes have no fewer than 100 words (warn) or 0 words (fail)
• Vignettes have a Flesch-Kincaid readability score lower than 50 (warn) or 30 (fail)
• All exported functions have examples in their documentation