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
56
57
58
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/pandoc.R
\name{pandoc_convert}
\alias{pandoc_convert}
\title{Convert a document with pandoc}
\usage{
pandoc_convert(input, to = NULL, from = NULL, output = NULL,
citeproc = FALSE, options = NULL, verbose = FALSE, wd = NULL)
}
\arguments{
\item{input}{Character vector containing paths to input files
(files must be UTF-8 encoded)}
\item{to}{Format to convert to (if not specified, you must specify
\code{output})}
\item{from}{Format to convert from (if not specified then the format is
determined based on the file extension of \code{input}).}
\item{output}{Output file (if not specified then determined based on format
being converted to).}
\item{citeproc}{\code{TRUE} to run the pandoc-citeproc filter (for processing
citations) as part of the conversion.}
\item{options}{Character vector of command line options to pass to pandoc.}
\item{verbose}{\code{TRUE} to show the pandoc command line which was executed}
\item{wd}{Working directory in which code will be executed. If not
supplied, defaults to the common base directory of \code{input}.}
}
\description{
Convert documents to and from various formats using the pandoc utility.
}
\details{
Supported input and output formats are described in the
\href{http://johnmacfarlane.net/pandoc/README.html}{pandoc user guide}.
The system path as well as the version of pandoc shipped with RStudio (if
running under RStudio) are scanned for pandoc and the highest version
available is used.
}
\examples{
\dontrun{
library(rmarkdown)
# convert markdown to various formats
pandoc_convert("input.md", to = "html")
pandoc_convert("input.md", to = "pdf")
# process citations
pandoc_convert("input.md", to = "html", citeproc = TRUE)
# add some pandoc options
pandoc_convert("input.md", to="pdf", options = c("--listings"))
}
}
|
