Skip to content

Replace several skip_<tools> parameters with a single skip_tools parameter #690

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
Merged
merged 12 commits into from
Mar 26, 2025
Merged

Replace several skip_<tools> parameters with a single skip_tools parameter #690

merged 12 commits into from
Mar 26, 2025

Conversation

ramprasadn
Copy link
Collaborator

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

@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 24, 2025 •
edited
Loading

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

Posted for pipeline commit cc9ca05

+| ✅ 203 tests passed       |+
#| ❔   7 tests were ignored |#
!| ❗  20 tests had warnings |!

❗ Test warnings:

  • local_component_structure - align.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - generate_cytosure_files.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - call_structural_variants.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - generate_clinical_set.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - qc_bam.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - call_mobile_elements.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - variant_evaluation.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - call_repeat_expansions.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - annotate_structural_variants.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - annotate_mobile_elements.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - prepare_references.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - annotate_mt_snvs.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - annotate_repeat_expansions.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - annotate_genome_snvs.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - gens.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - call_snv.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - annotate_consequence_pli.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - rank_variants.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - scatter_genome.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - subsample_mt.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure

❔ Tests ignored:

  • files_exist - File is ignored: conf/modules.config
  • files_unchanged - File ignored due to lint config: .github/CONTRIBUTING.md
  • files_unchanged - File ignored due to lint config: .github/PULL_REQUEST_TEMPLATE.md
  • files_unchanged - File ignored due to lint config: assets/nf-core-raredisease_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-raredisease_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-raredisease_logo_dark.png
  • modules_config - modules_config

✅ Tests passed:

Run details

  • nf-core/tools version 3.2.0
  • Run at 2025-03-24 17:23:37

@ramprasadn ramprasadn marked this pull request as ready for review March 25, 2025 08:10
kubranarci
kubranarci reviewed Mar 25, 2025
View reviewed changes
nextflow.config
skip_me_calling = false
skip_me_annotation = false
skip_mt_annotation = false
skip_repeat_annotation = false
skip_repeat_calling = false
skip_smncopynumbercaller = false
skip_snv_annotation = false
Copy link

Choose a reason for hiding this comment

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

are you planning to add another skip parameter for the remaining params? Or you plan to infer it from samplesheet in future?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Other skip parameters turn off entire subworkflows so it would be misleading to combine them under skip_tools. So as of now, I don't plan on combining them with skip_tools:)

Copy link

Choose a reason for hiding this comment

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

himm, maybe having them combine into --skip_subworkflows, or adding like --steps "snvcalling, snvannotation,repeat_annotation" might work.. I guess I am into clustering :)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

That's a good idea. I will do that in a different PR.

nextflow_schema.json
"type": "boolean",
"description": "Specifies whether or not to skip smncopynumbercaller.",
"fa_icon": "fas fa-toggle-on"
},
"skip_snv_annotation": {
Copy link

Choose a reason for hiding this comment

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

might make sense to add more general skip option here? like skip "annotation"? I think it would be a rare case to have lets say snvannotation on while svannotaton off?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Depends on the use case, I believe. There are scenarios where someone might have updated databases for SNVs, and in such cases, they might not want to run SV annotation.

CHANGELOG.md
| skip_germlinecnvcaller | |
| skip_peddy | |
| skip_smncopynumbercaller | |
| skip_vcf2cytosure | |
Copy link

Choose a reason for hiding this comment

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

add skip_fastqc

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

skip_fastqc doesn't exist actually. I just added that functionality to skip_tools 😅

kubranarci
kubranarci approved these changes Mar 25, 2025
View reviewed changes
Copy link

@kubranarci kubranarci left a comment

Choose a reason for hiding this comment

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

LGTM :)

@ramprasadn ramprasadn merged commit a0560a4 into dev Mar 26, 2025
16 checks passed
@ramprasadn ramprasadn deleted the skip_tools branch March 27, 2025 07:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kubranarci kubranarci kubranarci approved these changes

@jemten jemten Awaiting requested review from jemten

@fellen31 fellen31 Awaiting requested review from fellen31

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ramprasadn @kubranarci