Rdo_args2txt {gbRd} | R Documentation |
Extract help descriptions of one or more arguments of a function and return them as a string.
Rdo_args2txt(rdo, arg, title = "Hhh", name = "Aa", type = "text")
rdo |
the documentation for the topic, typically an Rd object but
may be anything that |
arg |
name(s) of argument(s) to describe, a character vector, see also Details section |
title |
Title, a string |
name |
name, a string |
type |
type of the help, defaults to "text" |
The title
and name
fields are there, since descriptions of
arguments usually do not use the same header as the description of
the corresponding function.
The current defaults show that this is still not finished.
A string (character vector of length one).
Georgi N. Boshnakov
# ?seq
cat(Rdo_args2txt("seq", c("by", "...")))
cat(Rdo_args2txt("seq", c("from", "by")))