nf-core / nf-core/tools

Template: inconsistency between pipeline_test_database_path parameters

Open
#3,614 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Description of the bug

In nextflow.config: https://github.com/nf-core/tools/blob/5e54606219ad9dff4c3505900057eabfd56daee1/nf_core/pipeline-template/nextflow.config#L54

In tests/nextflow.config: https://github.com/nf-core/tools/blob/5e54606219ad9dff4c3505900057eabfd56daee1/nf_core/pipeline-template/tests/nextflow.config#L10

We should pick one for consistency.

The former makes it easier for infrastructure devs to keep this consistent across pipelines.
The latter is easier for pipeline devs as they don't have to remember to repeatedly use the name of the pipelien in their suffix strings when refering to the file.

Command used and terminal output

System information

No response

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

Compare the pipeline_test_database_path definitions in nf_core/pipeline-template/nextflow.config and nf_core/pipeline-template/tests/nextflow.config. Review the issue discussion to determine which parameter convention was chosen, then update the template configuration so both locations are consistent. Done means the two referenced configurations use the same convention.

Written by the indexing model from the issue text.

Assessment

Domain
tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.