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
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utils-vignettes.R
\name{vignette_engines}
\alias{vignette_engines}
\title{Package vignette engines}
\description{
Since R 3.0.0, package vignettes can use non-Sweave engines, and \pkg{knitr}
has provided a few engines to compile vignettes via \code{\link{knit}()} with
different templates. See \url{https://yihui.org/knitr/demo/vignette/} for
more information.
}
\note{
If you use the \code{knitr::rmarkdown} engine, please make sure that
you put \pkg{rmarkdown} in the \samp{Suggests} field of your
\file{DESCRIPTION} file. Also make sure \command{pandoc} is available
during \command{R CMD build}. If you build your package from RStudio, this
is normally not a problem. If you build the package outside RStudio, run
\code{rmarkdown::find_pandoc()} in an R session to check if Pandoc can be
found.
When the \pkg{rmarkdown} package is not installed or not available, or
\command{pandoc} cannot be found, the \code{knitr::rmarkdown} engine will
fall back to the \code{knitr::knitr} engine, which uses R Markdown v1 based
on the \pkg{markdown} package.
}
\examples{
library(knitr)
vig_list = tools::vignetteEngine(package = "knitr")
str(vig_list)
vig_list[["knitr::knitr"]][c("weave", "tangle")]
vig_list[["knitr::knitr_notangle"]][c("weave", "tangle")]
vig_list[["knitr::docco_classic"]][c("weave", "tangle")]
}
|
