Rd2markdown: Convert Rd help files to markdown.

Description Usage Arguments References See Also

Description

Converts the help topics in the given package to markdown.

Usage

1
2
3
4
  Rd2markdown(pkg, topics, outdir, public.only = TRUE,
    data.topics = TRUE, file.ext = "markdown",
    link.ext = "html", section.sep = "\n\n", front.matter,
    verbose = TRUE, ...)

Arguments

pkg

the package to generate files for.

topics

the topics to convert to markdown. If missing all topics will be converted.

public.only

if TRUE and topics not specified, include only exported functions as determined by ls('package:PackageName').

data.topics

if TRUE, include data help pages.

verbose

if TRUE, print messages as parsing.

...

other parameters passed to Rd2markdown.rd

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.

section.sep

character to print between sections.

front.matter

text to include at the top of the file.

References

Murdoch, D. (2010). Parsing Rd files.

See Also

Rd2markdown.rd

Rd2HTML


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