nextflow-io / nextflow-io/nextflow

In summary report, allow breakdowns by sub-workflow for processes

Open
#4,751 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue stale
Dominant language
Groovy
Stars
3.5k
Forks
811
Avg merge
2d 11h
Merged PRs (30d)
61

Description

New feature

I would like to request a (static) config option, or perhaps a (dynamic) toggle in the interactive plotly figures to allow me to de-aggregate process resource reports based on which sub-workflows they were executed under.

Usage scenario

I re-use the same process definitions in different sub-workflows in my main nextflow workflow (see https://github.com/nextflow-io/nextflow/discussions/4750 for more on this). When I look at the resulting "Nextflow Workflow Report" all the processes are aggregated together in the figures.

Suggest implementation

It appears this information is available inside the existing report data, as in the table at the end, processes are labelled <NAMED_SUB_WORKFLOW>:<DEEPER_NAMED_SUBWORKFLOW>:<PROCESS>. Breaking down the data using the subworkflow labels should thus be fairly easy.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the Nextflow Workflow Report generation and the interactive Plotly figures, then compare them with the report table where process labels include sub-workflow names. Define whether a static config option or interactive toggle is appropriate, and consider the work done when resource reports can break down processes by their sub-workflow labels.

Written by the indexing model from the issue text.

Assessment

Tech stack
groovy, plotly
Domain
analytics, data-visualization
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.