tools

This package provides tools for developing packages.

Functions

FunctionDescription
Rd2HTMLThis (experimental) function converts from an R help page to an HTML document.
Rd2exThis (experimental) function converts from an R help page to the format used by example.
Rd2latexThis (experimental) function converts from an R help page to a LaTeX document.
Rd2txtThis (experimental) function converts from an R help page to a text document.
Rd_dbBuilds a simple database of all R documentation (Rd) sources in a package, as a list of character vectors with the lines of the Rd files in the package.
RdiffGiven two R output files, computes differences, ignoring headers, footers, and some encoding differences.
RdindexPrints a two-column index table with names and titles from given R documentation files to a given output file or connection. The titles are nicely formatted between two column positions (typically 25 and 72, respectively).
buildVignettesRuns Sweave and texi2dvi on all vignettes of a package.
checkDocFilesChecks, for all Rd files in a package, whether all arguments shown in the usage sections of the Rd file are documented in its arguments section.
checkDocStyleInvestigates how (S3) methods are shown in the usages of the Rd files in a package.
checkFFPerforms checks on calls to compiled code from R code.
checkMD5sumsChecks the files against a file “MD5”.
checkNEWSReads R’s NEWS file or a similarly formatted one. This is an experimental feature, new in R 2.4.0, and may change in several ways.

Get R in a Nutshell now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.