as_notebook: Render vignettes as .ipynb notebooks

In Bioconductor/AnVILPublish: Publish Packages and Other Resources to AnVIL Workspaces

Render vignettes as .ipynb notebooks

Description

as_notebook() renders Rmarkdown (.Rmd) or Quarto (.Qmd) vignettes as Juptyer (.ipynb) notebooks. The vignettes and notebooks are updated in an AnVIL workspace.

Usage

as_notebook(
  rmd_paths,
  namespace,
  name,
  update = FALSE,
  type = c("ipynb", "rmd", "both"),
  quarto = c("render", "convert")
)

Arguments

rmd_paths	character() paths to Rmd or Qmd 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⁠.
type	character(1) The type of notebook to be copied to the workspace. Must be on of ipynb, rmd, or both. ipynb copies only the Jupyter notebook. rmd copies Rmarkdown and Quarto vignettes. both copies both notebooks and vignettes.
quarto	character(1) If the program Quarto is installed, this parameter indicates whether the .Rmd files will be rendered or converted. See vignette for more details.

Details

See the vignette "Publishing R / Bioconductor Packages To AnVIL Workspaces" for details on the conversion process; best results are obtained when Quarto software is available.

Value

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

Bioconductor/AnVILPublish documentation built on May 5, 2024, 1:16 a.m.