R.oo: setNameFormat.Rdoc – R documentation

Pricing

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

Get Started for Free

Documentation

R.oo

setNameFormat.Rdoc

Sets the current name format

Description

Sets the current name format. Throws a RccViolationException if an unknown format is requested.

Usage

## Static method (use this):
## Rdoc$setNameFormat(nameFormat, ...)

## Don't use the below:
## S3 method for class 'Rdoc'
setNameFormat(static, nameFormat, ...)

Arguments

`nameFormat`	If `"method.class"`, help files for methods belonging to classes are named <method>.<class>. If `"class.method"`, help files for methods belonging to classes are named <class>.<method>. These are currently the only name formats supported.
`...`	Not used.

Value

Returns nothing.

Author(s)

Henrik Bengtsson