mlr3misc: rd_info – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

rd_info

Helpers to Create Manual Pages

Description

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 of `x`. Will be replicated to lenght 2.
`packages`	(`character()`) Vector of package names.

Value

character(), possibly with markdown code.

mlr3misc

Helper Functions for 'mlr3'

v0.10.0

LGPL-3

Authors

Michel Lang [cre, aut] (<https://orcid.org/0000-0001-9754-0393>), Patrick Schratz [aut] (<https://orcid.org/0000-0003-0748-6624>)

Initial release