argsToString.Rdoc: Gets the arguments signature of a function

Rdoc$argsToStringR Documentation

Gets the arguments signature of a function

Description

Gets the arguments signature of a function.

Usage

## Static method (use this):
## Rdoc$argsToString(fcn, escapeRd=FALSE, collapse=TRUE, ...)

## Don't use the below:
## S3 method for class 'Rdoc'
argsToString(static, fcn, escapeRd=FALSE, collapse=TRUE, ...)

Arguments

fcn

A function.

escapeRd

If TRUE, certain Rd markup symbols are escaped.

collapse

If TRUE, each argument is returned as a single string, otherwise split up into a vector of strings as far as possible.

...

Not used.

Value

Returns a list of character strings.

Author(s)

Henrik Bengtsson

See Also

For more information see Rdoc.


R.oo documentation built on Nov. 2, 2024, 1:07 a.m.