devtools: check_man – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

check_man

Check documentation, as R CMD check does.

Description

This function attempts to run the documentation related checks in the same way that R CMD check does. Unfortunately it can't run them all because some tests require the package to be loaded, and the way they attempt to load the code conflicts with how devtools does it.

Usage

check_man(pkg = ".")

Arguments

pkg

The package to use, can be a file path to the package or a package object. See as.package() for more information.

Value

Nothing. This function is called purely for it's side effects: if

Examples

## Not run: 
check_man("mypkg")

## End(Not run)

devtools

Tools to Make Developing R Packages Easier

v2.4.1

MIT + file LICENSE

Authors

Hadley Wickham [aut], Jim Hester [aut, cre], Winston Chang [aut], RStudio [cph, fnd]

Initial release