rd2html: Convert all Rd files in a directory to HTML files in a new...

In psychTools: Tools to Accompany the 'psych' Package for Psychological Research

Convert all Rd files in a directory to HTML files in a new directory

Description

Just a wrapper for tools::RdHTML to find a directory (e.g., the Man directory of help files) and convert them to HTML files in a new directory. Useful for adding HTML help files to a local web page.

Usage

rd2html(inDir =NULL,outDir=NULL, nfiles=NULL,package="psych",file=NULL)

Arguments

inDir	The input directory. If NULL,then a file in a directory will be searched for using file.choose()
outDir	Where to write the output files
nfiles	If not NULL, then how many files should be written
package	name of package
file	If specified, just convert this one file to HTML

Details

Just a wrapper for Rd2HTML calling some file tools. An interesting use of the function is to precheck whether all the help files are syntactically correct.

Author(s)

William Revelle

See Also

See Also as filesList, filesInfo

Examples

if(interactive()) {
#This is an  interactive function whic require interactive input and thus is not given as examples
rd2html()

}

psychTools documentation built on May 29, 2024, 9:47 a.m.