R.oo (version 1.0.3)

Rdoc: Class for converting Rdoc comments to Rd files

Description

Package: R.oo Class Rdoc Object ~~| ~~+--Rdoc Directly known subclasses: public static class Rdoc extends Object Class for converting Rdoc comments to Rd files.

Usage

Rdoc()

Fields and Methods

Methods: rll{ check Checks the compiled Rd files. compile Compile source code files containing Rdoc comments into Rd files. createManPath Creates the directory where the Rd files should be saved. escapeRdFilename Escape non-valid characters in a filename. getKeywords Gets the keywords defined in R with descriptions. getManPath Gets the path to the directory where the Rd files will be saved. getNameFormat Gets the current name format. isKeyword Checks if a word is a Rd keyword. setManPath Sets the path to the directory where the Rd files should be saved. setNameFormat Sets the current name format. } Methods inherited from Object: $, $<-, [[, [[<-, as.character, attach, clone, detach, equals, extend, finalize, getFields, getInstanciationTime, getStaticInstance, hasField, hashCode, ll, load, objectSize, print, save

References

R developers, Guidelines for Rd files, http://developer.r-project.org/Rds.html, 2003 Gordon Smyth, Writing .Rd Files For S4 Classes, Generic Functions and Methods, http://bioinf.wehi.edu.au/limma/Rdocs.html, 2003

Examples

# Set default author
author <- "Henrik Bengtsson, \url{http://www.braju.com/R/}"

# Show the file containing the Rdoc comments
rdocFile <- system.file("misc", "Exception.R", package="R.oo")
file.show(rdocFile)

# Compile the Rdoc:s into Rd files (saved in the destPath directory)
destPath <- tempdir()
Rdoc$compile(rdocFile, destPath=destPath)

# List the generated Rd files
rdFiles <- list.files(destPath, full.names=TRUE)
print(rdFiles)

# Show one of the files
file.show(rdFiles[1])

# Clean up
file.remove(rdFiles)