rd_info() is an internal generic to generate Rd or markdown code to be used in manual pages.
rd_format_string() and rd_format_range() are string functions to assist generating
proper Rd code.
Usage
rd_info(obj, ...)
rd_format_range(lower, upper)
rd_format_string(str, quote = c("\\dQuote{", "}"))
rd_format_packages(packages)Arguments
- obj
(
any)
Object of the respective class.- ...
(
any))
Additional arguments.- lower
(
numeric(1))
Lower bound.- upper
(
numeric(1))
Upper bound.- str
(
character())
Vector of strings.- quote
(
character())
Quotes to use around each element ofx.Will be replicated to lenght 2.
- packages
(
character())
Vector of package names.
Value
character(), possibly with markdown code.