dev_help: In-development help for package loaded with devtools

Description Usage Arguments Examples

View source: R/dev-help.r

Description

dev_help searches for source documentation provided in packages loaded by devtools. To improve performance, the .Rd files are parsed to create to index once, then cached. Use dev_topic_index_reset to clear that index.

Usage

1
2
3
4
dev_help(topic, dev_packages = NULL, stage = "render",
  type = getOption("help_type"))

dev_topic_index_reset(pkg_name)

Arguments

topic

name of help to search for.

dev_packages

A character vector of package names to search within. If NULL, defaults to all packages loaded by devtools.

stage

at which stage ("build", "install", or "render") should \Sexpr macros be executed? This is only important if you're using \Sexpr macro's in your Rd files.

type

of html to produce: "html" or "text". Defaults to your default documentation type.

pkg_name

Name of package.

Examples

1
2
3
4
5
6
7
8
## Not run: 
library("ggplot2")
help("ggplot") # loads installed documentation for ggplot

load_all("ggplot2")
dev_help("ggplot") # loads development documentation for ggplot

## End(Not run)

r-lib/pkgload documentation built on Nov. 4, 2018, 8:41 p.m.