parseRd: Parse an Rd object
In Rd2md: Markdown Reference Manuals
Description
Usage
Arguments
Value
Examples
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
1
parseRd(rd)
Arguments
rd
An Rd object.
Value
a named list with the parts of the Rd object that will be used for creating
a markdown file
Examples
1
2
3
4
## rd source (from parse_Rd function of tools package)
rdfile = "~/git/MyPackage/man/myfun.Rd"
## rd = tools::parse_Rd(rdfile)
## parseRd(rd)
Rd2md documentation built on Feb. 2, 2021, 1:07 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Value Examples
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
1 | parseRd(rd)
|
Arguments
rd |
An |
Value
a named list with the parts of the Rd object that will be used for creating a markdown file
Examples
1 2 3 4 | ## rd source (from parse_Rd function of tools package)
rdfile = "~/git/MyPackage/man/myfun.Rd"
## rd = tools::parse_Rd(rdfile)
## parseRd(rd)
|
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.