Learn R Programming

Rdpack (version 0.4-4)

promptUsage: Usage text for a function, S3 method or S4 method

Description

Obtains the usage text for a function, S3 method or S4 method for inclusion in the usage section of Rd documentation.

Usage

get_usage(object, name = NULL, force.function = FALSE, ...,
          S3class = "", S4sig = "", infix = FALSE, fu = TRUE,
          out.format = "text")

promptUsage(..., usage)

Arguments

...
for promptUsage, arguments to be passed on to get_usage; for get_usage, currently not used.
usage
an usage object, see Details.
object
a function object or a character name of one.
name
the name of a function, a string.
force.function
enforce looking for a function.
S3class
the S3 class of the function, a character vector.
out.format
if "text", return the result as a character vector.
S4sig
(the signature of an S4 method, as used in Rd macro ## S3 method for class 'if TRUE the function is an infix operator.': \item{infixundefinedator. fu{if TRUE the object is a function, otherwise it is something else