1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/dev-help.R, R/dev-topic.R
\name{dev_help}
\alias{dev_help}
\alias{dev_topic_find}
\alias{dev_topic_index}
\alias{dev_topic_index_reset}
\title{In-development help for package loaded with devtools}
\usage{
dev_help(
topic,
dev_packages = NULL,
stage = "render",
type = getOption("help_type")
)
dev_topic_find(topic, dev_packages = NULL)
dev_topic_index(path = ".")
dev_topic_index_reset(pkg_name)
}
\arguments{
\item{topic}{name of help to search for.}
\item{dev_packages}{A character vector of package names to search within.
If \code{NULL}, defaults to all packages loaded by devtools.}
\item{stage}{at which stage ("build", "install", or "render") should
\verb{\\\\Sexpr} macros be executed? This is only important if you're using
\verb{\\\\Sexpr} macro's in your Rd files.}
\item{type}{of html to produce: \code{"html"} or \code{"text"}. Defaults to
your default documentation type.}
\item{path}{Path to package.}
\item{pkg_name}{Name of package.}
}
\description{
\code{dev_help()} searches for source documentation provided in packages
loaded by devtools. To improve performance, the \code{.Rd} files are
parsed to create to index once, then cached. Use
\code{dev_topic_index_reset()} to clear that index. You can manually
retrieve the index for a local package with \code{dev_topic_index()}.
}
\examples{
\dontrun{
library("ggplot2")
help("ggplot") # loads installed documentation for ggplot
load_all("ggplot2")
dev_help("ggplot") # loads development documentation for ggplot
}
}
|
