R: Knit package documentation

knit_rd {knitr} | R Documentation

## 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()

### Arguments

`pkg` | package name
`links` | a character vector of links to be passed to `Rd2HTML`
`frame` | whether to put a navigation frame on left of the index page

### 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.

### Note

Ideally the html pages should be put under the ‘html’ directory of an installed package which can be found via `system.file('html', package = 'your_package_name')`, otherwise some links may not work (e.g. the link to the DESCRITION file).

### Examples

    library(knitr)
    ## Not run:

    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

    ## End(Not run)

[Package knitr version 1.16 Index]