Skip to main content

nextflow lineage

Added in version 25.04
warning

Experimental: may change in a future release.

Inspect lineage metadata for Nextflow runs.

Usage

$ nextflow lineage SUBCOMMAND [arg ..]

Description

The lineage command inspects lineage metadata.

See Getting started with data lineage for more information.

Options

-h, -help

Print the command usage.

Subcommands

check <lid>

Validate the checksum of an output lineage record.

diff <lid-1> <lid-2>

Display a git-style diff between two lineage records.

find <field-1>=<value-1> [<field-2>=<value-2> ...]

Find all lineage records that match the given field values.

list

List the Nextflow runs with lineage enabled and print the lineage ID (LID) of each run.

render <lid> [path]

Render the lineage graph for a lineage record as an HTML file (default output path: ./lineage.html).

The lineage record should be of type FileOutput, TaskRun, or WorkflowRun.

view <lid>

View a lineage record.

Examples

List the runs with lineage enabled:

$ nextflow lineage list

View a lineage record:

$ nextflow lineage view lid://16b31030474f2e96c55f4940bca3ab64

View the lineage record of a published file:

$ nextflow lineage view lid://16b31030474f2e96c55f4940bca3ab64/multiqc_report.html

Find all tasks belonging to a given run:

$ nextflow lineage find type=TaskRun workflowRun=lid://16b31030474f2e96c55f4940bca3ab64

Compare two lineage records:

$ nextflow lineage diff lid://862df53160e07cd823c0c3960545e747 lid://9433dda73f2193491f9a26e3e23cd8a1

Validate the checksum of an output lineage record:

$ nextflow lineage check lid://16b31030474f2e96c55f4940bca3ab64/multiqc_report.html

Render the lineage graph of a published file:

$ nextflow lineage render lid://16b31030474f2e96c55f4940bca3ab64/multiqc_report.html