Rdo_args2txt_list {gbRd} | R Documentation |
Extract the descriptions of the arguments of a function
Description
Collect the descriptions of the arguments of a function in a named list with one element per argument.
Usage
Rdo_args2txt_list(x, arg, ...)
Arguments
x |
help object, may be any of the types that
|
arg |
A character vector naming the arguments to describe. If |
... |
additional arguments to pass to |
Details
If several arguments are described in a single documentation entry, then the whole text of the entry is given for each of the arguments.
Value
A named list with one entry (a string) for each of the requested arguments.
Author(s)
Georgi N. Boshnakov
See Also
Examples
# each arg always gets an individual entry in the list;
# compare:
Rdo_args2txt_list("seq", c("from", "to", "by"))
# to:
cat(Rdo_args2txt("seq", c("from", "to", "by")))
[Package gbRd version 0.4.12 Index]