parseSourceFile: parseSourceFileParse a R-source-code regarding annotated...
In michelk/annotSrcDoc.R: Minimal documentation out of annotated function source code
Description
Usage
Arguments
Value
Examples
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, 2019, 9:55 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Value Examples
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
|
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.