Rd2md (version 0.0.5)

ReferenceManual: Create Reference Manual Markdown

Description

This is a wrapper to combine the Rd files of a package source or binary into a reference manual in markdown format.

Usage

ReferenceManual(
  pkg = getwd(),
  outdir = getwd(),
  front.matter = "",
  toc.matter = "",
  date.format = "%B %d, %Y",
  verbose = FALSE
)

Arguments

pkg

Full path to package directory. Default value is the working directory. Alternatively, a package name can be passed. If this is the case, find.package is applied.

outdir

Output directory where the reference manual markdown shall be written to.

front.matter

String with yaml-style heading of markdown file.

toc.matter

String providing the table of contents. This is not auto-generated. The default value is a HTML comment, used by gitbook plugin toc.

date.format

Date format that shall be written to the beginning of the reference manual. If NULL, no date is written. Otherwise, provide a valid format (e.g. %Y-%m-%d), see Details in strptime.

verbose

If TRUE all messages and process steps will be printed

References

Murdoch, D. (2010). Parsing Rd files

See Also

Package Rd2markdown by jbryer

Examples

## give source directory of your package
pkg_dir = "~/git/MyPackage"

## specify, where reference manual shall be stored
out_dir = "/var/www/html/R_Web_app/md/"

## create reference manual
## ReferenceManual(pkg = pkg_dir, outdir = out_dir)