parseHelp: Extract argument descriptions from the documentation of a...
In GeoBosh/fguigb: Create GUI for functions
Description
Usage
Arguments
Details
Value
Author(s)
Examples
Description
Parse the documentation of an object to extract argument
descriptions.
Usage
1
parseHelp(func)
Arguments
func
a function name or function.
Details
This function is a replacement of the function with the same name in
package fgui with improved parsing based on the new
(R>=2.10) help system.
This version of parseHelp detects when multiple arguments are
described in one entry and allocates that entry to each of them,
see the example with seq.default which describes from,to
together.
Value
A named list with one entry (a string) for each argument of f.
Author(s)
Georgi N. Boshnakov
Examples
1
2
3
GeoBosh/fguigb documentation built on May 30, 2019, 8:25 a.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 Details Value Author(s) Examples
Description
Parse the documentation of an object to extract argument descriptions.
Usage
1 | parseHelp(func)
|
Arguments
func |
a function name or function. |
Details
This function is a replacement of the function with the same name in package fgui with improved parsing based on the new (R>=2.10) help system.
This version of parseHelp detects when multiple arguments are
described in one entry and allocates that entry to each of them,
see the example with seq.default which describes from,to
together.
Value
A named list with one entry (a string) for each argument of f.
Author(s)
Georgi N. Boshnakov
Examples
1 2 3 |
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.