nf-core / nf-core/website

nf-core schema build default file names should match the convention

Open
#2,002 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug infrastructure pipeline-tools
Dominant language
MDX
Stars
98
Forks
298
Avg merge
14h 38m
Merged PRs (30d)
38

Description

Describe the bug
When using nf-core schema build and adding a "schema" to a parameter, the suggested name is input_schema.json, while the convention in the pipeline template is schema_input.json

Expected behaviour
We should build the suggested name with schema_<PARAM_NAME>.json

Additional context
Reported on Slack: https://nfcore.slack.com/archives/C056RQB10LU/p1695134974457569?thread_ts=1695134590.612809&cid=C056RQB10LU

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 at the nf-core schema build command and trace where the suggested schema filename is assembled. Compare the current input_schema.json suggestion with the pipeline template convention, and verify that a parameter named <PARAM_NAME> produces schema_<PARAM_NAME>.json.

Written by the indexing model from the issue text.

Assessment

Domain
cli
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.