modules icon indicating copy to clipboard operation
modules copied to clipboard

Add gtf2featureannotation module

Open pinin4fjords opened this issue 2 years ago • 1 comments

PR checklist

Adding module wrapper for https://github.com/ebi-gene-expression-group/atlas-gene-annotation-manipulation. See also https://nfcore.slack.com/archives/CJRH30T6V/p1665413183508719.

Apologies for the long name, didn't quite think that through at the time I wrote this tool!

Closes https://github.com/nf-core/modules/issues/2316

  • [x] This comment contains a description of changes (with reason).
  • [x] If you've fixed a bug or added code that should be tested, add tests!
  • [x] If you've added a new tool - have you followed the module conventions in the contribution docs
  • [x] If necessary, include test data in your PR.
  • [x] Remove all TODO statements.
  • [x] Emit the versions.yml file.
  • [x] Follow the naming conventions.
  • [x] Follow the parameters requirements.
  • [x] Follow the input/output options guidelines.
  • [x] Add a resource label
  • [x] Use BioConda and BioContainers if possible to fulfil software requirements.
  • Ensure that the test works with either Docker / Singularity. Conda CI tests can be quite flaky:
    • [x] PROFILE=docker pytest --tag <MODULE> --symlink --keep-workflow-wd --git-aware
    • [x] PROFILE=singularity pytest --tag <MODULE> --symlink --keep-workflow-wd --git-aware
    • [x] PROFILE=conda pytest --tag <MODULE> --symlink --keep-workflow-wd --git-aware

pinin4fjords avatar Oct 17 '22 17:10 pinin4fjords

@nf-core-bot fix linting

pinin4fjords avatar Oct 17 '22 17:10 pinin4fjords

Thanks for review @ramprasadn! Requested changes done.

pinin4fjords avatar Oct 18 '22 11:10 pinin4fjords

Thanks for the guidance @ramprasadn - how's this?

pinin4fjords avatar Oct 18 '22 12:10 pinin4fjords

Module looks good, just a few changes to the docs and it should be 👌🏻

ramprasadn avatar Oct 18 '22 13:10 ramprasadn

Module looks good, just a few changes to the docs and it should be 👌🏻

Done!

pinin4fjords avatar Oct 18 '22 14:10 pinin4fjords

As I understand it, this module is for converting a GTF file to an annotation table. So within a pipeline, it will be called just once on the GTF file provided as reference. Actually in the case of operating on reference data the meta maps are not needed, as there is no sample-specific information to be forwarded to the module itself. See for example some genome indexing modules as the salmon index one (https://github.com/nf-core/modules/blob/master/modules/nf-core/salmon/index/main.nf).

ggabernet avatar Oct 20 '22 11:10 ggabernet

As I understand it, this module is for converting a GTF file to an annotation table. So within a pipeline, it will be called just once on the GTF file provided as reference. Actually in the case of operating on reference data the meta maps are not needed, as there is no sample-specific information to be forwarded to the module itself. See for example some genome indexing modules as the salmon index one (https://github.com/nf-core/modules/blob/master/modules/nf-core/salmon/index/main.nf).

Haha- well, that was my original thinking, but you and @ramprasadn will have to fight it out :-D

The module has a lot of options for deriving the data in different ways, e.g. for different feature sets (e.g. genes, transcripts), so I can see the potential for multiple uses per workflow.

pinin4fjords avatar Oct 20 '22 11:10 pinin4fjords

ok well if you can see the use to the meta map in the module, then it can always be provided as an empty list to the channel if not needed 👍

ggabernet avatar Oct 20 '22 11:10 ggabernet

Thanks for reviews @ggabernet @ramprasadn !

pinin4fjords avatar Oct 20 '22 13:10 pinin4fjords