Create a Boilerplate Package Rd Function Documentation

Source: R/pkg_rd.R

Creates a boilerplate package Rd function documentation.

pkg_rd(pkg_root, msg = "z.Rd file path:")

Arguments

pkg_root

Character string. Package root directory.
msg

Character string. Optional message. If supplied, prints msg dir/fn.

Details

Note that if pkg_create() is used, this function will be called.

If you are going to document, check, and build your package using devtools, you may delete the Rd function documentation file generated by this function.

Author

Ivan Jacob Agaloos Pesigan

Examples

if (FALSE) {
pkg_rd(
  pkg_root = "~/boilerplatePackage"
)
}