Rd2md (version 0.0.5)

parseRd: Parse an Rd object

Description

This function will parse an Rd object returning a list with each section. The contents of each element of the list will be converted to markdown.

Usage

parseRd(rd)

Value

a named list with the parts of the Rd object that will be used for creating a markdown file

Arguments

rd

An Rd object.

Examples

## rd source (from parse_Rd function of tools package)
rdfile = "~/git/MyPackage/man/myfun.Rd"
## rd = tools::parse_Rd(rdfile)
## parseRd(rd)