knitr (version 1.46)

knit_rd: Knit package documentation

Description

Run examples in a package and insert output into the examples code; knit_rd_all() is a wrapper around knit_rd() to build static HTML help pages for all packages under the html directory of them.

Usage

knit_rd(pkg, links = tools::findHTMLlinks(), frame = TRUE)
knit_rd_all()

Value

All HTML pages corresponding to topics in the package are written under the current working directory. An index.html is also written as a table of content.

Arguments

pkg

Package name.

links

A character vector of links to be passed to tools::Rd2HTML().

frame

Boolean: whether to put a navigation frame on the left of the index page.

Examples

library(knitr)
if (FALSE) {

knit_rd("maps")
knit_rd("rpart")
setwd(system.file("html", package = "ggplot2"))
knit_rd("ggplot2")  # time-consuming!

knit_rd_all()  # this may take really long time if you have many packages installed
}