parseSourceFile: parseSourceFileParse a R-source-code regarding annotated...

Description Usage Arguments Value Examples

View source: R/parseSourceFile.R

Description

Annotation has to look like myFun <- functionCompute something ##Optional multiline ##description ( xargument x is something; could also be multiline ,yargument y is another something ) doSomething(x,y) Returns this

Usage

1
    parseSourceFile(f, p '\s*# \^\s*')

Arguments

f

source-code-file

p '\s*# \^\s*'

general annotation pattern (default '

Value

Returns a 'FunctionDoc'

Examples

1
2
3
4
5
##---- Should be DIRECTLY executable !! ----
##-- ==>  Define data, use random,
##--	or do  help(data=index)  for the standard data sets.

## The function is currently defined as

michelk/annotSrcDoc.R documentation built on May 22, 2017, 6:51 a.m.