package_file_skeleton: Generate package file skeletons

In unDocUMeantIt/roxyPackage: Utilities to Automate Package Builds

Generate package file skeletons

Description

Writes a new file with some basic comments and documentation hints, according to the type of R object to cover.

Usage

package_file_skeleton(
  name,
  type = c("function", "S4Class", "S4Method", "data")
)

Arguments

name	Character string, name of the object the file should cover (i.e., a function or class name).
type	One of "function", "S4Class", "S4Method", or "data", categorizing the object to be documented.

unDocUMeantIt/roxyPackage documentation built on July 26, 2024, 5:57 p.m.