Learn R Programming

berryFunctions (version 1.5.2)

createDoc: Create Documentation file from .r-source

Description

Create Documentation file (especially section arguments) from .r-source

Usage

createDoc(fun, path = "S:/Dropbox/Public/berryFunctions")

Arguments

fun
Character string or unqouted name. Function (== filename) with correct structure in source code.
path
Path to package in development containing folders 'R' and 'man'. DEFAULT: "S:/Dropbox/Public/berryFunctions"

Details

This assumes the following structure of source code: MyFun <- function( arg1, # Explanation of this item}\cr arg2=TRUE, # Ditto, with default}\cr arg3) { None. Cats documentation for fun in path/man. Only usage, arguments and author section are filled, the rest is empty (but the frame is there). [object Object],[object Object],[object Object]
Warning
{This is highly specific to my way of working, don't rely blindly on it.} seealso{code{package.skeleton}, code{prompt}, code{scan}, code{cat}, Roxygen} examples{ #createDoc("textField") } keyword{documentation}