Learn R Programming

knitr (version 1.28)

knit2pandoc: Convert various input files to various output files using knit() and Pandoc

Description

Knits the input file and compiles to an output format using Pandoc.

Usage

knit2pandoc(
  input,
  output = NULL,
  tangle = FALSE,
  text = NULL,
  quiet = FALSE,
  envir = parent.frame(),
  to = "html",
  pandoc_wrapper = NULL,
  ...,
  encoding = "UTF-8"
)

Arguments

input

Path to the input file.

output

Path to the output file for knit(). If NULL, this function will try to guess a default, which will be under the current working directory.

tangle

Boolean; whether to tangle the R code from the input file (like Stangle).

text

A character vector. This is an alternative way to provide the input file.

quiet

Boolean; suppress the progress bar and messages?

envir

Environment in which code chunks are to be evaluated, for example, parent.frame(), new.env(), or globalenv()).

to

Character string giving the Pandoc output format to use.

pandoc_wrapper

An R function used to call Pandoc; by default, if rmarkdown is installed, this uses rmarkdown::pandoc_convert(), otherwise it pandoc().

...

Options to be passed to the pandoc_wrapper function.

encoding

Ignored (always assumes UTF-8).

Value

Returns the output of the pandoc_wrapper function.