mvbutils (version 2.5.4)

help2flatdoc: Convert help files to flatdoc format.

Description

Converts a vanilla R{} help file (as shown in the internal pager) to plain-text format. The output conventions are those in doc2Rd, so the output can be turned into Rd-format by running it through doc2Rd. This function is useful if you have existing Rd-format documentation and want to try out the flatdoc system of integrated code and documentation.

Usage

help2flatdoc( fun.name, pkg=NULL, text=NULL)

Arguments

fun.name

function name (a character string)

pkg

name of package

text

plain-text help

Details

The package containing fun.name must be loaded first. If you write documentation using flatdoc, prepare the package with pre.install, build it with RCMD BUILD or INSTALL, and run help2flatdoc on the result, you should largely recover your original flat-format documentation. Aliasses are deduced from function calls in the USAGE section. (Link-triggering phrases aren't explicitly created-- could look thru lists of linkable things I guess.)

See Also

doc2Rd

Examples

cd.doc <- help2flatdoc( "cd", "mvbutils")
print( cd.doc)
cd.Rd <- doc2Rd( cd.doc)