pack_fun: Generate a Basic roxygen2 .R File

Description Usage Arguments Value Examples

View source: R/pack_fun.R

Description

Generate a basic roxygen2 .R file

Usage

1
pack_fun(..., file = "", append = FALSE, copy2clip = TRUE)

Arguments

file

A connection, or a character string naming the file to print to. If "" (the default), cat prints to the standard output connection, the console unless redirected by sink.

append

append logical. Only used if the argument file is the name of file (and not a connection or "|cmd"). If TRUE output will be appended to file; otherwise, it will overwrite the contents of file. This allows for appnding to the main package .R file.

copy2clip

logical. If TRUE attempts to copy the output to the clipboard.

...

A function.

Value

Returns a basic .R file for a function with roxygen2 documentation.

Examples

1

trinker/acc.roxygen2 documentation built on May 27, 2017, 1:45 p.m.