Rdoc$compile | R Documentation |
Compile source code files containing Rdoc comments into Rd files.
Note, the class and methods to be compiled have to be loaded into
R by for instance library()
or source()
before calling
this method.
## Static method (use this):
## Rdoc$compile(filename=".*[.]R$", destPath=getManPath(this), showDeprecated=FALSE,
## addTimestamp=FALSE, locale="C", verbose=FALSE, source=FALSE, check=TRUE,
## debug=FALSE, ...)
## Don't use the below:
## S3 method for class 'Rdoc'
compile(this, filename=".*[.]R$", destPath=getManPath(this), showDeprecated=FALSE,
addTimestamp=FALSE, locale="C", verbose=FALSE, source=FALSE, check=TRUE, debug=FALSE,
...)
filename |
The pathname or filename pattern of the Rdoc files to be compiled. |
destPath |
The path where the generated Rd files should be saved. |
showDeprecated |
If |
addTimestamp |
If |
locale |
The locale to be set/used when compiling Rdoc comments. This help assuring strings are sorted the same way across systems. |
source |
If |
verbose |
If |
debug |
If |
... |
Not used. |
Returns nothing.
Henrik Bengtsson
For more information see Rdoc
.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.