Rdo_get_argument_names: Get the names of arguments in usage sections of Rd objects
In Rdpack: Update and Manipulate Rd Documentation Objects
Rdo_get_argument_names R Documentation
Get the names of arguments in usage sections of Rd objects
Description
Get the names of arguments in usage sections of Rd objects.
Usage
Rdo_get_argument_names(rdo)
Arguments
rdo
an Rdo object.
Details
All arguments names in the "arguments" section of rdo are
extracted. If there is no such section, the results is a character
vector of length zero.
Arguments which have different descriptions for different OS'es
are included and not duplicated.
Arguments which have descriptions for a particular OS are included,
irrespectively of the OS of the running R process.
(todo: introduce argument to control this?)
Value
a character vector
Author(s)
Georgi N. Boshnakov
See Also
Rdo_get_item_labels
Examples
##---- Should be DIRECTLY executable !! ----
Rdpack documentation built on Nov. 8, 2023, 5:06 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.
| Rdo_get_argument_names | R Documentation |
Get the names of arguments in usage sections of Rd objects
Description
Get the names of arguments in usage sections of Rd objects.
Usage
Rdo_get_argument_names(rdo)
Arguments
rdo |
an Rdo object. |
Details
All arguments names in the "arguments" section of rdo are
extracted. If there is no such section, the results is a character
vector of length zero.
Arguments which have different descriptions for different OS'es are included and not duplicated.
Arguments which have descriptions for a particular OS are included, irrespectively of the OS of the running R process. (todo: introduce argument to control this?)
Value
a character vector
Author(s)
Georgi N. Boshnakov
See Also
Rdo_get_item_labels
Examples
##---- Should be DIRECTLY executable !! ----
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.