Description

Render a Quarto notebook, including parametrization.

Input

name:type
description
pattern

meta:map

Groovy Map containing sample information e.g. [ id:'sample1', single_end:false ].

notebook:file

The Quarto notebook to be rendered.

*.{qmd}

parameters:map

Groovy map with notebook parameters which will be passed to Quarto to generate parametrized reports.

input_files:file

One or multiple files serving as input data for the notebook.

*

extensions:file

A quarto _extensions directory with custom template(s) to be available for rendering.

*

Output

name:type
description
pattern

html

meta:map

Groovy Map containing sample information e.g. [ id:'sample1', single_end:false ].

*.html:file

HTML report generated by Quarto.

*.html

notebook

meta:map

Groovy Map containing sample information e.g. [ id:'sample1', single_end:false ].

${notebook}:file

The original, un-rendered notebook.

*.[qmd,ipynb,rmd]

artifacts

meta:map

Groovy Map containing sample information e.g. [ id:'sample1', single_end:false ].

artifacts/*:file

Artifacts generated during report rendering.

*

params_yaml

meta:map

Groovy Map containing sample information e.g. [ id:'sample1', single_end:false ].

params.yml:file

Parameters used during report rendering.

*

extensions

meta:map

Groovy Map containing sample information e.g. [ id:'sample1', single_end:false ].

_extensions:file

Quarto extensions used during report rendering.

*

versions

versions.yml:file

File containing software versions.

versions.yml

Tools

quartonotebook
MIT

An open-source scientific and technical publishing system.