Description Usage Arguments Value Examples
Create a file in inst containing the description of all the arguments from the Rd file of a package
1 | listDocArgs(dir, trace = TRUE)
|
dir |
the path to the directory containing the R package |
trace |
should the execution of the function be traced |
a list containing:
argByFunction name of the arguments of the functions/methods that are documented.
docByFunction description of the arguments of the functions/methods that are documented.
functionNames name of the functions/methods that are documented.
dtAll data.table object gathering function names, argument names, and description of the arguments
1 2 3 4 5 6 | ## Not run:
res <- listDocArgs(file.path(pathGitHub(),"butils.base"))
res$functionNames
res$argByFunction
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.