Description

Render a Quarto notebook, including parametrization.

Input

name:type
description
pattern

meta{:bash}

:map

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

notebook{:bash}

:file

The Quarto notebook to be rendered.

*.{qmd}

parameters{:bash}

:map

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

input_files{:bash}

:file

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

*

extensions{:bash}

:file

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

*

Output

name:type
description
pattern

html{:bash}

meta{:bash}

:map

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

*.html{:bash}

:file

HTML report generated by Quarto.

*.html

notebook{:bash}

meta{:bash}

:map

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

notebook{:bash}

:file

The Quarto notebook that was rendered. Allows user to continue working on the notebook.

*.{qmd}

params_yaml{:bash}

meta{:bash}

:map

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

params.yml{:bash}

:file

Parameters used during report rendering.

*

artifacts{:bash}

meta{:bash}

:map

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

${notebook_parameters.artifact_dir}/*{:bash}

:file

Artifacts generated during report rendering.

*

extensions{:bash}

meta{:bash}

:map

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

_extensions{:bash}

:file

Quarto extensions used during report rendering.

*

versions{:bash}

versions.yml{:bash}

:file

File containing software versions.

versions.yml

Tools

quartonotebook
MIT

An open-source scientific and technical publishing system.