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.

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

DSL2: add reference masking for PMDtools #1030

Merged
merged 8 commits into from
Dec 8, 2023

Conversation

scarlhoff
Copy link
Contributor

@scarlhoff scarlhoff commented Oct 27, 2023

This adds the options to run PMDtools only on a specific part of the genome within the damage manipulation subworkflow. Input options are the mapping reference, an already masked fasta file and a bed file for masking of the mapping reference.
This closes #1029.

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 - add to the software_versions process and a regex to scrape_software_versions.py
    • If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](https://github.com/nf-core/eager/tree/master/.github/CONTRIBUTING.md)
    • If necessary, also make a PR on the nf-core/eager 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).
  • 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).

Copy link

github-actions bot commented Nov 10, 2023

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit a62d332

+| ✅ 159 tests passed       |+
!| ❗  20 tests had warnings |!

❗ Test warnings:

  • pipeline_todos - TODO string in README.md: Include a figure that guides the user through the major workflow steps. Many nf-core
  • pipeline_todos - TODO string in README.md: Fill in short bullet-pointed list of the default steps in the pipeline
  • pipeline_todos - TODO string in nextflow.config: Specify your pipeline's command line flags
  • pipeline_todos - TODO string in main.nf: Remove this line if you don't need a FASTA file
  • pipeline_todos - TODO string in test_full.config: Specify the paths to your full test data ( on nf-core/test-datasets or directly in repositories, e.g. SRA)
  • pipeline_todos - TODO string in test_full.config: Give any required params for the test so that command line flags are not needed
  • pipeline_todos - TODO string in test_humanbam.config: Specify the paths to your test data on nf-core/test-datasets
  • pipeline_todos - TODO string in test_humanbam.config: Give any required params for the test so that command line flags are not needed
  • pipeline_todos - TODO string in test.config: Specify the paths to your test data on nf-core/test-datasets
  • pipeline_todos - TODO string in test.config: Give any required params for the test so that command line flags are not needed
  • pipeline_todos - TODO string in base.config: Check the defaults for all processes
  • pipeline_todos - TODO string in base.config: Customise requirements for specific processes.
  • pipeline_todos - TODO string in usage.md: Add documentation about anything specific to running your pipeline. For general topics, please point to (and add to) the main nf-core website.
  • 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 WorkflowEager.groovy: Optionally add in-text citation tools to this list.
  • pipeline_todos - TODO string in WorkflowMain.groovy: Add Zenodo DOI for pipeline after first release
  • pipeline_todos - TODO string in awsfulltest.yml: You can customise AWS full pipeline tests as required
  • pipeline_todos - TODO string in ci.yml: You can customise CI pipeline run tests as required
  • schema_description - No description provided in schema for parameter: skip_qualimap
  • schema_description - No description provided in schema for parameter: skip_damage_calculation

✅ Tests passed:

Run details

  • nf-core/tools version 2.10
  • Run at 2023-12-07 09:05:59

@scarlhoff scarlhoff marked this pull request as ready for review November 10, 2023 13:48
@scarlhoff scarlhoff requested a review from a team November 10, 2023 13:48
@scarlhoff scarlhoff linked an issue Nov 10, 2023 that may be closed by this pull request
Copy link
Member

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

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

From my phone so not tested, but theoretically looks good :)

conf/modules.config Outdated Show resolved Hide resolved
docs/development/dev_docs.md Outdated Show resolved Hide resolved
docs/development/dev_docs.md Outdated Show resolved Hide resolved
docs/development/dev_docs.md Outdated Show resolved Hide resolved
docs/development/dev_docs.md Outdated Show resolved Hide resolved
docs/output.md Outdated Show resolved Hide resolved
conf/modules.config Outdated Show resolved Hide resolved
docs/output.md Outdated Show resolved Hide resolved
nextflow_schema.json Outdated Show resolved Hide resolved
subworkflows/local/manipulate_damage.nf Outdated Show resolved Hide resolved
subworkflows/local/reference_indexing.nf Outdated Show resolved Hide resolved
@scarlhoff scarlhoff requested a review from TCLamnidis November 24, 2023 09:02
Copy link
Collaborator

@TCLamnidis TCLamnidis left a comment

Choose a reason for hiding this comment

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

One minor helptext suggestion, but otherwise LGTM!

nextflow_schema.json Outdated Show resolved Hide resolved
@TCLamnidis TCLamnidis closed this Dec 6, 2023
@TCLamnidis TCLamnidis reopened this Dec 6, 2023
@scarlhoff scarlhoff merged commit 7ac6cb0 into nf-core:dev Dec 8, 2023
18 checks passed
@scarlhoff scarlhoff deleted the dsl2_pmd_maskedfasta branch August 9, 2024 09:27
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.

DSL2: add reference masking for PMDtools
3 participants