schardtbc / Rd2md

Package for creating markdown versions of R package reference manual.

Installation

To install the Rd2md package, you can either use the official CRAN repository or install directly from github.

From CRAN:

install.packages("Rd2md")

From Github:

## if not already installed:
# install.packages("devtools") 
library(devtools)
install_github("quants-ch/Rd2md")

However, please not that github will always have the most recent version available.

Reference Manual To Markdown

There main function to create the reference manual in markdown format is

ReferenceManual(pkg, outdir)

Please read the introduction vignette for further information and consult the available function docs.