nbconvert: Jupyter/IPython Notebook Conversion

In theislab/nbconvertR: Vignette Engine Wrapping Jupyter Notebooks

Description

An R interface for using Jupyter/IPython system calls to convert .ipynb notebooks unsing meta information. When passed "<filename>.ipynbmeta" it will convert "<filename>.ipynb" to "<filename>.<ext>".

Usage

nbconvert(file, fmt = c("html", "latex", "markdown", "pdf", "rst",
  "script", "slides"), quiet = TRUE, ...)

nbconvert_html(file, quiet = TRUE, ...)
nbconvert_latex(file, quiet = TRUE, ...)
nbconvert_markdown(file, quiet = TRUE, ...)
nbconvert_pdf(file, quiet = TRUE, ...)
nbconvert_rst(file, quiet = TRUE, ...)
nbconvert_script(file, quiet = TRUE, ...)
nbconvert_slides(file, quiet = TRUE, ...)

Arguments

file	A file with a .ipynbmeta extension that contains vignette metadata lines
fmt	A format supported by nbconvert. "script" will create an .r file, and "slides" a reveal.js-powered html presentation.
quiet	Suppress command output if TRUE (the output will always be shown on error)
...	Ignored for now

Details

Apart from the standard %\VignetteIndexEntry{<name>} and %\VignetteEngine{<namespace>::<name>} directives, it also understands:

1. %\VignetteTemplate{<format>}{<filename>}, which will pass a --template parameter to nbconvert

2. %\VignettePreprocessors{<format>}{<module>.<Preproc>[, ...]}, which will pass --<Format>Exporter.preprocessors=["<module>.<Preproc>",...] to nbconvert.

Value

The filename of the resulting document, script or presentation

Examples

## Not run: 
path <- system.file('doc/test-vignette.ipynbmeta', package = 'nbconvertR')
nbconvert(path, 'pdf')

## End(Not run)

theislab/nbconvertR documentation built on Nov. 27, 2019, 5:58 p.m.