add.roxy: add.roxy

In colinpmillar/cpmtools: Miscellaneous Functions by 'Colin Millar'

add.roxy

Description

adds roxygen documentation headers to the top on R function and optionally write this to a file in the R folder.

Usage

add.roxy(obj, file = FALSE)

Arguments

obj	the function to create documentation for
file	if TRUE write to file (R/function name.R), Default: FALSE

Value

TRUE if successful, FALSE if not

See Also

makeOxygen tidy_source

Examples

## Not run: 
if(interactive()){
 #EXAMPLE1
 }

## End(Not run)

colinpmillar/cpmtools documentation built on June 28, 2022, 10:35 p.m.