Args {svMisc}R Documentation

Show function arguments in a human-readable way - get a call tip

Description

Args() displays function arguments in a better way than args() does. It is primarily intended for code tips in GUIs.

Usage

Args(name, only.args = FALSE)
CallTip(code, only.args = FALSE, location = FALSE)

Arguments

name A string with the name of a function
code A fraction of R code ending with the name of a function, eventually followed by '('
only.args Do we return only arguments of the function (arg1, arg2 = TRUE, ...), or the full call, like (myfun(arg1, arg2 = TRUE, ...)).
location If TRUE then the location (in which package the function resides) is appended to the calltip between square brackets

Value

A string with the calling syntax of the function

Note

Args() is supposed to display S3 and S4 methods, and primitives adequately,... but this is not implemented yet in the current version!

Author(s)

Philippe Grosjean <phgrosjean@sciviews.org>

Examples

        Args("ls")
        CallTip("myvar <- lm(")

[Package svMisc version 0.9-46 Index]