Skip to contents

Create Markdown Reference Manual

Source: R/render_refman.R
render_refman.Rd

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

Usage

render_refman(pkg = getwd(), output_file = NULL, output_format = md_document())

Arguments

pkg

Full path to package directory. Default value is the current working directory. Alternatively, a package name can be passed as string. If this is the case, base::find.package() is applied.

output_file

Specify outputfile, including file extension

output_format

Output format function. See output_format(). Default is md_document(), but one could provide a custom output format.

References

Murdoch, D. (2010). Parsing Rd files

See also

  • Package Rd2markdown, on which the original version was based on.

  • Package pkgdown, on which the current (refactored) version is based on.

Examples

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

## create reference manual
## render_refman(pkg_dir)