Learn R Programming

devtools (version 2.4.5)

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 = ".")

Value

Nothing. This function is called purely for it's side effects: if no errors there will be no output.

Arguments

pkg

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

Examples

Run this code
if (FALSE) {
check_man("mypkg")
}

Run the code above in your browser using DataLab