nf-core / nf-core/modules

[FEATURE] about nf-core modules that runs a template script

Open
#5,350 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

For current nf-core modules. We store a script inside the path modules/nf-core/module_name/templates.
If one wants to run a process with this script, some implementations do for example:

script:
template "template_name.py"
Describe the solution you'd like

I wonder why don’t we just do:

script:
template_name.py $input --arg1 $arg1 --ext.args

Is this not recommended? Why? Maybe some more information about how to do this properly?

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

Review the template scripts under modules/nf-core/module_name/templates and the documented examples using template "template_name.py". Determine whether invoking template_name.py directly with arguments is supported or recommended, then document the correct usage and rationale for nf-core module authors.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.