Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Display a warning when '--extra_star_align_args' are used with RSEM #1049

Merged
merged 2 commits into from
Jun 15, 2023
Merged

Display a warning when '--extra_star_align_args' are used with RSEM #1049

merged 2 commits into from
Jun 15, 2023

Conversation

MatthiasZepper
Copy link
Member

Since RSEM imposes its own arguments for STAR alignment, custom mapping parameters are not supported for the STAR-RSEM route.

Therefore, --star_extra_alignment_args are silently ignored when the STAR-RSEM route is chosen. As suggested by Thomas Danhorn on Slack, an explicit warning is now displayed to emphasize this.

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 lint).
  • Ensure the test suite passes (nextflow run . -profile 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).

@github-actions
Copy link

github-actions bot commented Jun 14, 2023 •
edited
Loading

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit dff30b5

+| ✅ 149 tests passed       |+
#| ❔   5 tests were ignored |#
!| ❗   4 tests had warnings |!

❗ Test warnings:

  • files_exist - File not found: .github/workflows/awstest.yml
  • files_exist - File not found: .github/workflows/awsfulltest.yml
  • nextflow_config - Config manifest.version should end in dev: '3.12.0'
  • pipeline_todos - TODO string in methods_description_template.yml: #Update the HTML below to your prefered methods description, e.g. add publication citation for this pipeline

❔ Tests ignored:

  • files_unchanged - File ignored due to lint config: assets/email_template.html
  • files_unchanged - File ignored due to lint config: assets/email_template.txt
  • files_unchanged - File ignored due to lint config: lib/NfcoreSchema.groovy
  • files_unchanged - File ignored due to lint config: lib/NfcoreTemplate.groovy
  • actions_awstest - 'awstest.yml' workflow not found: /home/runner/work/rnaseq/rnaseq/.github/workflows/awstest.yml

✅ Tests passed:

Run details

  • nf-core/tools version 2.8
  • Run at 2023-06-14 16:23:08

@MatthiasZepper MatthiasZepper self-assigned this Jun 14, 2023
drpatelh
drpatelh reviewed Jun 14, 2023
View reviewed changes
lib/WorkflowRnaseq.groovy Outdated Show resolved Hide resolved
drpatelh
drpatelh reviewed Jun 14, 2023
View reviewed changes
CHANGELOG.md Outdated Show resolved Hide resolved
drpatelh
drpatelh approved these changes Jun 15, 2023
View reviewed changes
Copy link
Member

@drpatelh drpatelh left a comment

Choose a reason for hiding this comment

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

Thanks! 🚀

@drpatelh drpatelh merged commit 6636fcc into nf-core:dev Jun 15, 2023
@MatthiasZepper MatthiasZepper deleted the ExtraStarAlignArgsWarning branch June 22, 2023 10:20
@drpatelh drpatelh changed the title Display a warning when '--star_extra_alignment_args' are used with RSEM Display a warning when '--extra_star_align_args' are used with RSEM Jul 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@drpatelh drpatelh drpatelh approved these changes

Assignees

@MatthiasZepper MatthiasZepper

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@MatthiasZepper @drpatelh