pkg_rd: Create a Boilerplate Package 'Rd' Function Documentation

In jeksterslabds/jeksterslabRpkg: Package Utility Functions

Description

Creates a boilerplate package Rd function documentation.

Usage

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(s)

Ivan Jacob Agaloos Pesigan

Examples

## Not run: 
pkg_rd(
  pkg_root = "~/boilerplatePackage"
)

## End(Not run)

jeksterslabds/jeksterslabRpkg documentation built on Jan. 22, 2021, 11:43 p.m.