rd2list: Parse documentation in Rd list format into a human-readable...

Description Usage Arguments Details Value

Description

This function is named to be similar to the Rd2HTML and Rd2txt functions in the tools package.

Usage

1
rd2list(rd_doc)

Arguments

rd_doc

An Rd object as returned by tools::parse_Rd or get_rd_doc. An Rd doc is a list of lists with attributes. The list elements at the top-most level represent the sections within the documentation.

Details

In contrast to those functions, Rd2list can only be given an Rd object.

Value

structured character strings in a list object


coolbutuseless/rd2list documentation built on May 20, 2019, 9:41 a.m.