formatR (version 0.7)

usage: Show the usage of a function

Description

Print the reformatted usage of a function. The arguments of the function are searched by argsAnywhere, so the function can be either exported or non-exported in a package. S3 methods will be marked.

Usage

usage(FUN, width = 0.77)

Arguments

FUN

the function name

width

the width of output

Value

• NULL; the usage is printed on screen

See Also

tidy.source

Examples

library(formatR)
usage(var)

usage(plot)

usage(plot.default)  # default method
usage(plot.lm)  # on the 'lm' class

usage(usage)

usage(barplot.default, width = 0.6)  # narrower output