nf-core / nf-core/tools

extra information in pipeline_info for reproducibility

Open
#2,824 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good-first-issue
Dominant language
Python
Stars
322
Forks
255
Avg merge
2d 3h
Merged PRs (30d)
5

Description

Description of feature

Hello,

I've been running some custom pipeline in AWS and found it useful to adopt the nf-core practice of dumping useful pipeline information into the pipeline_info directory: execution reports, parameters and versions.

However I've found the nf-core pipelines lacking some key information to ensure a complete capture of the execution environment (for reproducibility purposes) that I've added to my own production pipelines:

  1. First and most importantly is that the input sample sheet is not being copied to this location, this is after all part of the input parameters for the pipeline.

  2. Additional information from the workflow introspection: commandLine, commitID, runName, resume

So it would be very useful if all of this was part of the nf-core template, being that for production environments it really makes a difference as it saves one from having to copy the required files manually and reduces the chance of errors.

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

The issue names no files or tests; start by locating the nf-core template entry point that creates the pipeline_info directory and inspect how execution reports, parameters, and versions are collected. Done means the template captures the input sample sheet and the requested workflow information: commandLine, commitID, runName, and resume.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws
Domain
cloud, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.