nf-core / nf-core/tools

Print warning if an nf-core module no longer exists.

Open
#2,905 0 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

Once a module has been installed from nf-core modules, it may be that it needs to be moved from tool to tool/subtool/ to accommodate the addition of further subtools. In this case the normal deprecation guidelines do not apply and the main.nf and corresponding files have to be deleted because of checks on nf-core modules. As a result, if a user who has already installed the module runs an update, nf-core tools will check for the file and not find it there.
The user should get a warning that the file could have been moved, and additionally the option to keep or remove the module locally.

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 tracing the nf-core tools update path that checks installed module files and determines whether they still exist. Implement the requested warning for a missing module, including an option to keep or remove it locally; done means the update flow presents that choice when the module may have moved.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.