Movatterモバイル変換

pandoc

pandoc is currently an experimental R packageprimarily develop to help maintainers of R Markdown ecosystem.

Indeed, the R Markdown ecosystem is highly dependent on Pandoc (https://pandoc.org/) changesand it is designed to be as version independent as possible. R Markdownis best used with the latest Pandoc version but anyrmarkdown package version should work with previousversion of Pandoc, and new change in Pandoc should not break anyrmarkdown features.

This explains the needs for a more focused tooling to:

• Install and manage several Pandoc versions. This is useful fortesting versions and comparing between them.
• Call Pandoc’s command directly without the layers added byrmarkdown. This is useful for debugging or quicklyiterating and finding where a bug comes from.
• Retrieve information from Pandoc directly. Each version comes withchanges and some of them are included into the binary. Being able toretrieve those information and compare between versions is important tohelp maintain the user exposed tooling.

This package can also be useful to advanced developers that areworking around Pandoc throughrmarkdown or not.

Installation

Install from CRAN:

install.packages("pandoc")

The development version can be install fromGitHub with:

# install.packages("pak")pak::pak("cderv/pandoc")

Usage

All functions are prefixed withpandoc_ and you willfind below their main usage. SeeGetstarted for usage examples andReferencepage for full details of functions.

Most functions follows these following rules:

• They are prefixed withpandoc_ .
• They can be used with any installed Pandoc version usingversion argument.
• Versions to use are passed as a string, either the version number(e.g"2.14.2" ), or one special alias(default,nightly ,rstudio ,system) .

Available functions allows:

• Installing / Uninstalling specific Pandoc version from ‘2.0.3’ to‘3.1.6.2’ , including development version of Pandoc.
  • pandoc_install(),pandoc_install_nightly(),pandoc_uninstall(),…
• Switching Pandoc version by activating a specific one or running anyfunction with a specific Pandoc version usingversion=argument.
  • pandoc_activate() ,with_pandoc() ,….
• Managing locally installed version of Pandoc as versions installedby this package are located within one folder per version in a user’sdata directory.
  • pandoc_installed_versions() ,pandoc_installed_latest ,pandoc::pandoc_is_installed() ,pandoc_locate(),pandoc_available(), …
• Using easily one of the installed version withrmarkdown (i.ermarkdown::render() willuse the version activated by this pandoc)
  • Seepandoc::pandoc_activate(rmarkdown = TRUE)
• Running a Pandoc binary from R, including a version installedsystem-wise (pandoc_bin("system")), or the version shippedwith RStudio (pandoc_bin("rstudio")).
• Calling binary at low-level from R with any version installed.
  • pandoc_run()
• to easily access information in R usually requiring command lineexecution
  • pandoc_version(),pandoc_list_extensions(),pandoc_export_template() , and all other wrappers…
• opening Pandoc’s resources from R
  • pandoc::pandoc_browse_manual(),pandoc::pandoc_browse_extension() , ….

Example

library(pandoc)# Install versionpandoc_install("2.7.3")#> ✔ Pandoc 2.7.3 already installed.#>   Use 'force = TRUE' to overwrite.pandoc_install("2.11.4")#> ✔ Pandoc 2.11.4 already installed.#>   Use 'force = TRUE' to overwrite.# Highest install is usedpandoc_version()#> [1] '3.1.6'

See detailed examples inGetstarted.

Code of Conduct

Please note that thepandoc project is released withaContributorCode of Conduct. By contributing to this project, you agree to abideby its terms.