nf-core/jupyternotebook @ 0.0.0-0c7146d
Summary
Render jupyter (or jupytext) notebooks to HTML reports. Supports parametrization through papermill.
Get started
Add the following snippet to your workflow script to include this module.
include { JUPYTERNOTEBOOK } from 'nf-core/jupyternotebook'
License
MIT License
Name
|
JUPYTERNOTEBOOK |
|---|
meta
map
|
Groovy Map containing sample information e.g. [ id:'test', single_end:false ] |
|---|---|
notebook
file
|
Jupyter notebook or jupytext representation thereof *.{ipynb,py,md,Rmd,myst}
|
parameters
map
|
Groovy map with notebook parameters which will be passed to papermill in order to create parametrized reports. |
|---|
input_files
file
|
One or multiple files serving as input data for the notebook. *
|
|---|
kernel_
string
|
Name of the kernel to use. |
|---|
report
tuple
meta
map
|
Groovy Map containing sample information e.g. [ id:'test', single_end:false ] |
|---|---|
*.html
file
|
HTML report generated from Jupyter notebook *.html
|
versions
versions.yml
file
|
File containing software versions versions.yml
|
|---|
artifacts
tuple
meta
map
|
Groovy Map containing sample information e.g. [ id:'test', single_end:false ] |
|---|---|
artifacts/
directory
|
Directory containing all artifacts generated by the notebook artifacts/
|
| Tool | Description | Homepage |
|---|---|---|
| jupytext | Jupyter notebooks as plain text scripts or markdown documents | https://github.com/mwouts/jupytext/ |
| papermill | Parameterize, execute, and analyze notebooks | https://github.com/nteract/papermill |
| nbconvert | Parameterize, execute, and analyze notebooks | https://nbconvert.readthedocs.io/en/latest/ |
| Version | 0.0.0-0c7146d |
|---|---|
| Commit ID | 135d883a43b1a2324b4112cd270cf22e20835533 |
| Release Date | 08 Apr 2026 18:50:19 (UTC) |
| Download URL | https://registry-stage.nextflow.io/api/v1/modules/nf-core%2Fjupyternotebook/0.0.0-0c7146d/download |
| OCI Store URL | https://public.cr.stage-seqera.io/v2/nextflow/plugin-stage/modules/nf-core/jupyternotebook/blobs/sha256:2da2d2bf320ffd55ea4af236ee69c13cdec85c000bee9f0fe7cc38b13816f05f |
| Size | 3.6 KB |
| Checksum | sha256:2da2d2bf320ffd55ea4af236ee69c13cdec85c000bee9f0fe7cc38b13816f05f |
| Downloads | 1 |
| Version | Date | Status | Downloads | Size | Diff |
|---|---|---|---|---|---|
| 0.0.0-0c7146d | 08 Apr 2026 18:50:19 (UTC) | 1 | 3.6 KB | - |