nf-core / nf-core/tools

Add args section in meta.yml

Open
#3,444 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Description of feature

As discussed in the slack thread

In @jfy133 words:

We need a new section for listing each args (2, 3, 4) with the sole(?) metadata
for each one is simply the tool of the pipe it is effecting.

In @mirpedrol words:

We want an extra section in the meta.yml to describe the ext.args values.
At the level of tools , inputs and outputs.

It would look like this:

tools:
  - "bcftools":
      description: "..."
      homepage: ...
      args_id: "$args"
      identifier: biotools:bcftools
  - "bcftools plugin setGT":
      description: "..."
      homepage: ...
      args_id: "$args2"
      identifier: biotools:bcftools
args:
  - args:
      description: ""
  - args2:
      description: ""
input:
  - - meta:
        ...
    - vcf:
        ...

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 existing meta.yml structure, especially the tools, input, and output sections, then read the linked Slack discussion for the intended args metadata model. Done means the project has an agreed and implemented schema for describing ext.args values and their associated tools, inputs, and outputs.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
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.