roxygen_and_build | R Documentation |
After the source package is roxygenized, this function will build the
package. Optionally it also installs or checks the package, reformats the
code in the example sections. Note rab
is an alias of
roxygen_and_build
.
roxygen_and_build(
pkg,
build = TRUE,
build.opts = "--no-manual",
install = FALSE,
install.opts = if (build) "" else "--with-keep.source",
check = FALSE,
check.opts = "--as-cran --no-manual",
remove.check = TRUE,
reformat = TRUE,
before = NULL,
...
)
rab(
pkg,
build = TRUE,
build.opts = "--no-manual",
install = FALSE,
install.opts = if (build) "" else "--with-keep.source",
check = FALSE,
check.opts = "--as-cran --no-manual",
remove.check = TRUE,
reformat = TRUE,
before = NULL,
...
)
pkg |
the root directory of the source package |
build |
whether to build the package |
build.opts |
options to be passed to |
install |
whether to install the package |
install.opts |
options to be passed to |
check |
whether to check the package |
check.opts |
options to check the package (e.g. |
remove.check |
whether to remove the directory generated by |
reformat |
whether to reformat the example code; see
|
before |
an R expression to be evaluated under the package root directory before the package is roxygenized and built |
... |
other arguments passed to |
NULL
Yihui Xie <http://yihui.org>
## Not run:
roxygen_and_build("Rd2roxygen", install = TRUE)
## or simply
rab("Rd2roxygen", install = TRUE)
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.