nf-core / nf-core/modules

Add a parameter corresponding to -canonList <file> option of snpEff ann

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

Nobody has claimed this yet.

enhancement wishlist
Dominant language
Nextflow
Stars
429
Forks
1.1k
Avg merge
1d 6h
Merged PRs (30d)
153

Description

Description of feature

snpEff ann command has an option: -canonList <file>, that can take in a tab-separated file containing gene and transcript.

-canonList : Only use canonical transcripts, replace some transcripts using the `gene_id transcript_id` entries in <file>.

Propose to add a parameter (e.g. snpeff_canon_list), whose value should be a string indicating the path of the canonList file - Allowing users to supply custom canonList file to be used with snpEff ann command (SNPEFF_SNPEFF process).

Discussion on slack.
@maxulysse Thank you!

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 at the SNPEFF_SNPEFF process and inspect how its parameters are defined and passed to the snpEff ann command. Add the canonList path parameter and verify that a supplied tab-separated gene/transcript file is passed through when the process runs.

Written by the indexing model from the issue text.

Assessment

Domain
bioinformatics
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.