nbconvertR (version 1.0.2)

nbconvert: Jupyter/IPython Notebook Conversion

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 = FALSE, ...)

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

...

Ignored for now

Value

The filename of the resulting document, script or presentation

Details

Apart from the standard VignetteIndexEntry{<name>} and VignetteEngine{<namespace>::<name>} directives, it also understands VignetteTemplate{<format>}{<filename>}, which will pass a --template parameter to nbconvert

Examples

# NOT RUN {
path <- system.file('doc/test-vignette.ipynbmeta', package = 'nbconvertR')
nbconvert(path, 'pdf')
# }