nf-core / nf-core/tools

iGenomes: Set default base cache path

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

Nobody has claimed this yet.

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

Description

Description of feature

Currently, we encourage people to set --igenomes_base to use a local cache for reference genomes instead of downloading the assets for every run. However, this is not very obvious and many people don't do it.

It could be good to set a default cache location for iGenomes that is outside of the work directory, to avoid repeatedly downloading the same assets.

This needs to be visible as it could mean a lot of data. We need a sensible default path and also to log to the user about it.

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

The issue names no files, tests, or entry points, so begin by locating the iGenomes base-path handling and its existing --igenomes_base option. Define a sensible cache location outside work, make the default visible to users, and verify that repeated runs reuse the cache without unexpected downloads.

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.