Rd2markdown.rd: Converts an Rd help file to markdown.

In jbryer/Rd2markdown: Convert Rd files to markdown

Description

This function will convert an Rd file to markdown.

Usage

  Rd2markdown.rd(rd, outdir, file.ext = "markdown",
    link.ext = "html", front.matter,
    section = c("####", "####"), section.sep = "\n\n",
    run.examples = TRUE,
    knitrOptions = c(message = FALSE, warning = FALSE, error = FALSE))

Arguments

rd	an Rd data object.
outdir	directory to output the markdown file and any support files (e.g. figures). If missing, just the parsed results will be returned.
file.ext	file extension of the output file.
link.ext	file extension of linked files.
front.matter	text to include at the top of the file.
section	characters to surround section headings.
section.sep	character to print between sections.
run.examples	logical indicating whether to run the examples.
knitrOptions	options to pass to knitr for running the examples.

Value

a character vector of length one where the element name is the topic name and the value is the filename.

jbryer/Rd2markdown documentation built on May 18, 2019, 7:01 p.m.