Skip to content

Conversation

@FriederikeHanssen
Copy link
Contributor

@FriederikeHanssen FriederikeHanssen commented Aug 12, 2025

This PR add Sentieon support for STAR. The output of sentieon is equivalent to STAR. For this three modules where added:

  • SENTIEON_STARALIGN, that is added as additional option for STAR_ALIGN
  • SENTIEON_RSEMPREPAREREFERNCES, that is added as additional option for RSEM_PREPAREREFERENCES
  • SENTIEON_RSEMCALCULATEEXPRESSIONS, that is added as additional option for RSEM_CALCULATEEXPRESSION

Since Sentieon needs a number of things to be able to ping the license server, the respective scripts, and environment variables were added to :

  • bin/
  • the CI/CD workflows in .github
  • all test configs

Additional tests to test these changes were added for the individual subworkflows align and rsem, as well as 2 new pipeline level tests, one expanding the default one (star & salmon) with sentieon enabled, one that is testing star_rsem directly.

The usage docs on how to enable sentieon were added.

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the pipeline conventions in the contribution docs
  • If necessary, also make a PR on the nf-core/rnaseq branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core pipelines lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

@nf-core-bot
Copy link
Member

Warning

Newer version of the nf-core template is available.

Your pipeline is using an old version of the nf-core template: 3.3.1.
Please update your pipeline to the latest version.

For more documentation on how to update your pipeline, please see the nf-core documentation and Synchronisation documentation.

@github-actions
Copy link

github-actions bot commented Aug 12, 2025

nf-core pipelines lint overall result: Passed ✅ ⚠️

Posted for pipeline commit f228324

+| ✅ 290 tests passed       |+
#| ❔   7 tests were ignored |#
!| ❗   9 tests had warnings |!

❗ Test warnings:

  • files_exist - File not found: assets/multiqc_config.yml
  • pipeline_todos - TODO string in base.config: Check the defaults for all processes
  • pipeline_todos - TODO string in main.nf: Optionally add in-text citation tools to this list.
  • pipeline_todos - TODO string in main.nf: Optionally add bibliographic entries to this list.
  • pipeline_todos - TODO string in main.nf: Only uncomment below if logic in toolCitationText/toolBibliographyText has been filled!
  • pipeline_todos - TODO string in methods_description_template.yml: #Update the HTML below to your preferred methods description, e.g. add publication citation for this pipeline
  • pipeline_todos - TODO string in nextflow.config: Specify any additional parameters here
  • pipeline_todos - TODO string in awsfulltest.yml: You can customise AWS full pipeline tests as required
  • pipeline_if_empty_null - ifEmpty(null) found in main.nf: _ versions = ch_versions.ifEmpty(null) // channel: [ versions.yml ]
    _

❔ Tests ignored:

✅ Tests passed:

Run details

  • nf-core/tools version 3.3.2
  • Run at 2025-08-14 09:38:36

Copy link
Member

@maxulysse maxulysse left a comment

Choose a reason for hiding this comment

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

Llooking good, @pinin4fjords covered most of the questions already.
There are some minor typos left

Copy link
Contributor

@edmundmiller edmundmiller left a comment

Choose a reason for hiding this comment

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

Looks great to me!

Might have to revisit how we're testing Sentieon vs what we're supporting.

We could probably have a util for it in nf-core-utils 🤔

Copy link
Member

@pinin4fjords pinin4fjords left a comment

Choose a reason for hiding this comment

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

Nice clean solution, feel free to merge when you've sorted the tests, and sorry for my diversion ;-)

@FriederikeHanssen FriederikeHanssen merged commit 75ded6e into dev Aug 14, 2025
34 checks passed
@FriederikeHanssen FriederikeHanssen deleted the add_sentieon_star branch August 14, 2025 09:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Development

Successfully merging this pull request may close these issues.

6 participants