nf-core / nf-core/modules

[FEATURE] Update modules to include arity in path.

Open
#6,454 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

  • #5915 by @nvnieuwk — closed without merging
enhancement
Dominant language
Nextflow
Stars
429
Forks
1.1k
Avg merge
1d 6h
Merged PRs (30d)
153

Description

Is your feature request related to a problem? Please describe

It's not immediately clear reading module code if an input path channel is mandatory or optional.
Also, output files should clearly state whether a single file or a list of files should be emitted.

Describe the solution you'd like

arity should be used with any mandatory inputs and outputs to declare how many files are expected in/out.

Describe alternatives you've considered

No response

Additional context

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

Start by reviewing the repository's module definitions and the existing use of arity for input and output channels. Done means mandatory inputs and outputs declare their expected file counts, while optional inputs and single-versus-list outputs are unambiguous; the issue does not name specific files or tests.

Written by the indexing model from the issue text.

Assessment

Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.