Description Usage Arguments Author(s) Examples
The primary mechanism of inline documentation is via consecutive
groups of lines matching the specified prefix regular expression
"^###
" (i.e. lines beginning with "###
") are
collected as follows into documentation sections:
group starting at line 2 in the code
group following each function argument
group ending at the penultimate line of the code
These may be added to by use of the ##<<
constructs
described below.
1 | prefixed.lines(src, ...)
|
src |
|
... |
Toby Dylan Hocking <toby@sg.cs.titech.ac.jp> [aut, cre], Keith Ponting [aut], Thomas Wutzler [aut], Philippe Grosjean [aut], Markus Müller [aut], R Core Team [ctb, cph]
1 2 3 4 5 6 7 8 9 10 11 12 13 | test <- function
### the description
(x,
### the first argument
y ##<< another argument
){
5
### the return value
##seealso<< foobar
}
src <- getSource(test)
prefixed.lines(src)
extract.xxx.chunks(src)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.