Rd2markdown: Rd file to markdown

In Rd2md: Markdown Reference Manuals

Description

This function converts an Rd file into markdown format.

Usage

Rd2markdown(rdfile, outfile, append = FALSE)

Arguments

rdfile	Filepath to an .Rd file or an Rd object to parse.
outfile	Filepath to output file (markdown file).
append	If outfile exists, append to existing content.

Value

Parsed Rd as named list

Examples

## give a markdown source file
rdfile = "~/git/MyPackage/man/myfun.Rd"
## specify, where markdown shall be stored
outfile = "/var/www/html/R_Web_app/md/myfun.md"
## create markdown
## Rd2markdown(rdfile = rdfile, outfile = outfile)

Example output

Rd2md documentation built on Feb. 2, 2021, 1:07 a.m.