Skip to content

Tetranscripts#9635

Merged
hanalysis merged 59 commits intonf-core:masterfrom
hanalysis:tetranscripts
Jan 14, 2026
Merged

Tetranscripts#9635
hanalysis merged 59 commits intonf-core:masterfrom
hanalysis:tetranscripts

Conversation

@hanalysis
Copy link
Contributor

PR checklist

Closes #9628

Note - this module works as it currently is, but I could use some help adding something else. TEtranscripts usually works by searching in the same directory as the .bam files for a .bai file with the same naming convention. This is optional input (without the .bai, TEtranscripts just indexes the .bam files) which I understand would need to be passed through the same channels as the .bam files, and I haven't been able to get this to work. If anyone was happy to help me get this to work, I'd be very grateful, thanks!

  • If you've added a new tool - have you followed the module conventions in the contribution docs
  • If necessary, include test data in your PR. -> test data is here: Adding test data for TEtranscripts module test-datasets#1829
  • Remove all TODO statements.
  • Broadcast software version numbers to topic: versions - See version_topics
  • Follow the naming conventions.
  • Follow the parameters requirements.
  • Follow the input/output options guidelines.
  • Add a resource label
  • 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:
    • For modules:
      • [] nf-core modules test <MODULE> --profile docker
      • nf-core modules test <MODULE> --profile singularity
      • [] nf-core modules test <MODULE> --profile conda

Copy link
Contributor

@itrujnara itrujnara left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, thank you for the nice submission. There are some minor points for you to address. I have also left a suggestion about the index. Let me know if it works and if you need any further help.

pattern: "*.{bam}"

# Control BAM
ontologies: []
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should be ontologies for all the files, can you please find them? You can find a browser here

'biocontainers/tetranscripts:2.2.3--pyh7cba7a3_0' }"

input:
tuple val(meta_t), path(bam_t)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To add an optional index input, you should be able to simply extend these tuples. Nextflow does not have idiomatic optional arguments, but accepts [] as an empty value.

Copy link
Contributor

@itrujnara itrujnara left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes, it's almost ready now. You only need to add a test for the BAI input.

},
"timestamp": "2026-01-13T15:07:58.338450261"
},
"multiple files t - bam": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see any test where the BAM index is passed, can you please add one?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much for such a quick review!

Just added the final commit - it turns out TEtranscripts doesn't actually use the BAM index files. I had thought this because it throws this error message in the log "[E::idx_find_and_load] Could not retrieve index file for '.1712579023.8525763.bam'", but it seems that this is an artefact from pysam and not relevant to TEtranscripts processes (see: mhammell-laboratory/TEtranscripts#185).

So, I've removed the .bai optional input, and added a test for the multiple .bams, hopefully this is everything addressed now! Thanks again.

@hanalysis hanalysis requested a review from itrujnara January 14, 2026 10:37
Copy link
Contributor

@itrujnara itrujnara left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes, looks good now.

@hanalysis hanalysis enabled auto-merge January 14, 2026 15:27
@hanalysis hanalysis added this pull request to the merge queue Jan 14, 2026
Merged via the queue into nf-core:master with commit debd168 Jan 14, 2026
29 checks passed
@hanalysis hanalysis deleted the tetranscripts branch January 14, 2026 16:05
mmYeung pushed a commit to mmYeung/modules that referenced this pull request Jan 28, 2026
* adding tetranscripts module

* Updating test files and correcting command typo

* Successful singularity run test

* Adding multiple files to test - wip

* First effort to include multiple .bam

* Multiple .bam processing add

* Amending to test data

* Add --sortByPos to config for test

* Adding config to add parameters for test bams

* Trying locally

* Main working but stub failing with test data

* Public data working main test and stub

* Fixing linting!

* Still linting

* Linted and test passing public data - no .bai

* Working Singularity

* Remove TODO

* Removed lingering TODO, linting 2 warnings, pass test

* Changing main.nf to topics

* Updating meta.yml to topics

* Updating topics main.nf.test

* Topics update linting pass test fail

* Updated to topics passing linting and test

* Fixing meta.yml typo - now passing linting and testing.

* adding tetranscripts module

* Updating test files and correcting command typo

* Successful singularity run test

* Adding multiple files to test - wip

* First effort to include multiple .bam

* Multiple .bam processing add

* Amending to test data

* Add --sortByPos to config for test

* Adding config to add parameters for test bams

* Trying locally

* Main working but stub failing with test data

* Public data working main test and stub

* Fixing linting!

* Still linting

* Linted and test passing public data - no .bai

* Working Singularity

* Remove TODO

* Removed lingering TODO, linting 2 warnings, pass test

* Changing main.nf to topics

* Updating meta.yml to topics

* Updating topics main.nf.test

* Topics update linting pass test fail

* Updated to topics passing linting and test

* Fixing meta.yml typo - now passing linting and testing.

* Adding test for multiple bam files

* adding ontologies to meta.yml

* Adding .bai optional functionality

* Adding optional .txt output channels

* Removing bai input adding column test check for multiple files

* Run prettier to fix pre-linting

* Removing whitespace to pass prek

* Adding back in additional lines end of file

---------

Co-authored-by: Hannah Jones <hannah.18.jones@kcl.ac.uk>
Co-authored-by: Hannah Jones <jonesh1@cn093.nemo.thecrick.org>
Co-authored-by: Hannah Jones <jonesh1@cn092.nemo.thecrick.org>
Co-authored-by: Hannah Jones <jonesh1@login006.nemo.thecrick.org>
Co-authored-by: Hannah Jones <jonesh1@login007.nemo.thecrick.org>
cavenel pushed a commit to cavenel/modules that referenced this pull request Feb 5, 2026
* adding tetranscripts module

* Updating test files and correcting command typo

* Successful singularity run test

* Adding multiple files to test - wip

* First effort to include multiple .bam

* Multiple .bam processing add

* Amending to test data

* Add --sortByPos to config for test

* Adding config to add parameters for test bams

* Trying locally

* Main working but stub failing with test data

* Public data working main test and stub

* Fixing linting!

* Still linting

* Linted and test passing public data - no .bai

* Working Singularity

* Remove TODO

* Removed lingering TODO, linting 2 warnings, pass test

* Changing main.nf to topics

* Updating meta.yml to topics

* Updating topics main.nf.test

* Topics update linting pass test fail

* Updated to topics passing linting and test

* Fixing meta.yml typo - now passing linting and testing.

* adding tetranscripts module

* Updating test files and correcting command typo

* Successful singularity run test

* Adding multiple files to test - wip

* First effort to include multiple .bam

* Multiple .bam processing add

* Amending to test data

* Add --sortByPos to config for test

* Adding config to add parameters for test bams

* Trying locally

* Main working but stub failing with test data

* Public data working main test and stub

* Fixing linting!

* Still linting

* Linted and test passing public data - no .bai

* Working Singularity

* Remove TODO

* Removed lingering TODO, linting 2 warnings, pass test

* Changing main.nf to topics

* Updating meta.yml to topics

* Updating topics main.nf.test

* Topics update linting pass test fail

* Updated to topics passing linting and test

* Fixing meta.yml typo - now passing linting and testing.

* Adding test for multiple bam files

* adding ontologies to meta.yml

* Adding .bai optional functionality

* Adding optional .txt output channels

* Removing bai input adding column test check for multiple files

* Run prettier to fix pre-linting

* Removing whitespace to pass prek

* Adding back in additional lines end of file

---------

Co-authored-by: Hannah Jones <hannah.18.jones@kcl.ac.uk>
Co-authored-by: Hannah Jones <jonesh1@cn093.nemo.thecrick.org>
Co-authored-by: Hannah Jones <jonesh1@cn092.nemo.thecrick.org>
Co-authored-by: Hannah Jones <jonesh1@login006.nemo.thecrick.org>
Co-authored-by: Hannah Jones <jonesh1@login007.nemo.thecrick.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

new module: TEtranscripts

2 participants