nf-core / nf-core/tools

Make `.nf-core-lint.yml` more generic - use for download config?

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

Nobody has claimed this yet.

command line tools
Dominant language
Python
Stars
322
Forks
255
Avg merge
2d 3h
Merged PRs (30d)
5

Description

It would be nice to be able to have pipeline-specific config options for nf-core download in some cases, for example giving optional singularity image downloads for Sarek.

One idea could be to make .nf-core-lint.yml more generic (.nf-core.yml?) with sections for different tools. So still use it for the lint config, but within a lint section. Could then have a section for nf-core download as well for things like this.

Need to think about what format this file should have (still yaml, not toml etc?) and structure / effects.

'cc @maxulysse

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 reviewing the current .nf-core-lint.yml configuration and the nf-core download entry point. Decide the configuration format and section structure, then define what effects pipeline-specific download options should have while preserving lint configuration support. Done means the design is agreed and both lint and download use cases are covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, yaml
Domain
cli, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.