Configuration

Enable the plugin

plugins {
    id 'nf-arts@1.1.0'
}

At the end of the run, nf-arts writes art-<runName>.svg and art-<runName>.png to the launch directory.

In a pipeline you don’t edit

-plugins and a plugins {} block in a -c config both replace a pipeline’s plugins. List the pipeline’s own plugins too, or it fails to start:

nextflow run nf-core/rnavar -profile test,docker --outdir results \
    -plugins nf-core-utils@0.4.0,nf-schema@2.6.1,nf-arts@1.1.0

The pipeline’s plugins are in the plugins block of its nextflow.config.

The `arts` scope

arts {
    file    = "${params.outdir}/pipeline_info/art.png"
    style   = 'hilbert'
    palette = 'magma'
    width   = 1600
    height  = 1600
}

Option	Default	Description
`enabled`	`true`	Draw the artwork when the run ends.
`file`	`art-<runName>.svg` and `.png`	One output file instead of both. `.svg` or `.png` sets the format. Cloud paths work. Overwrites an existing file.
`style`	`radial`	One of the styles.
`layout`	`spiral`	How the `hive` style places processes on its spokes: `spiral` or `phase`.
`spokes`	`5`	Number of spokes in the `hive` style, at least 2, and at most one per process.
`palette`	`viridis`	`autumn`, `cividis`, `forest`, `magma`, `monarch`, `mondrian`, `mono`, `nfcore`, `ocean`, `okabe`, `rainbow`, `sunset` or `viridis`. Some styles have their own default.
`colors`		Hex colors (`#rrggbb`), overriding `palette`.
`background`	from the palette	Hex background color.
`width`, `height`	`1200`	Size in pixels, 16 to 10000.
`title`	`true`	The caption. See what goes into the art.

A bad value stops the run at the start, not at the end.

Palettes

Most palettes blend their colors from the first process to the last. mondrian cycles off-white, red, blue and yellow on black lines, without blending. monarch cycles orange, cream, red and amber on near-black. okabe, the colorblind-safe Okabe-Ito set, also cycles, so its 7 colors repeat in a run with more processes. cividis is a colorblind-safe blend.

Custom colors blend the same way:

arts {
    colors     = ['#ff006e', '#8338ec', '#3a86ff']
    background = '#ffffff'
}

Edit page