as_notebook {AnVILPublish}

R Documentation

Render vignettes as .ipynb notebooks

Description

as_notebook() renders .Rmd vignettes as .ipynb notebooks, and updates the notebooks in an AnVIL workspace.

Usage

as_notebook(rmd_paths, namespace, name, update = FALSE)

Arguments

rmd_paths	character() paths to to Rmd files.
namespace	character(1) AnVIL namespace (billing project) to be used.
name	character(1) AnVIL workspace name.
update	logical(1) Update (over-write any similarly named notebooks) an existing workspace? The default (FALSE) creates notebooks locally, e.g., for previewing via jupyter notebook *ipynb.

Details

.Rmd Vignettes are processed to .md using rmarkdown::render(..., md_document()), and then translated to .ipynb using python software called notedown; notedown is available at https://github.com/aaren/notedown.

The translation is not perfect, for instance code chunks marked
as `eval = FALSE` are not marked as such in the python notebook.

Value

as_notebook() returns the paths to the local (if update = FALSE) or the workspace notebooks.

---