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

added indexcov : finding large INDEL using the BAI index #1613

Merged
merged 37 commits into from
Dec 10, 2024

Conversation

lindenb
Copy link
Contributor

@lindenb lindenb commented Aug 5, 2024

original discussion: https://nfcore.slack.com/archives/C05V9FRJYMV/p1722884937141779?thread_ts=1696933327.769139&cid=C05V9FRJYMV

OK all, here I am one year later. I had the time to look at this code ! Let me remind you: goleft/indexcov can be used to fiind large INDEL using the BAI index.I've just implemented this in sarek and on my side I would be ready to submit a PR but I suppose some things needs to be fixed.

  • i added the nf-core/goleft/indexcov module
  • "indexcov" is now allowed in 'params.tools'
  • the subworkflow is in ./subworkflows/local/bam_variant_calling_indexcov/main.nf
    the documentation as been brefly updated
  • I created a local process used to generate a BAI with no unmapped,duplicate, etc... (./subworkflows/local/bam_variant_calling_indexcov/main.nf)
  • indexcov is only called for the germline worklfow, I don't have any experience with somatic/tumor WGS.
  • test are missing, I don't know what I should write. However, nf-test test tests/ --verbose --profile +singularity works
  • new config file ./conf/modules/indexcov.config

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/sarek branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core lint): Too many warnings but nothing related to 'indexcov'
  • Ensure the test suite passes (nf-test test tests/ --verbose --profile +docker).
  • 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 (I'm not sure how to set this without a PR hash...)
  • README.md is updated (including new tool citations and authors/contributors).

Copy link

github-actions bot commented Aug 5, 2024

This PR is against the master branch ❌

  • Do not close this PR
  • Click Edit and change the base to dev
  • This CI test will remain failed until you push a new commit

Hi @lindenb,

It looks like this pull-request is has been made against the lindenb/sarek master branch.
The master branch on nf-core repositories should always contain code from the latest release.
Because of this, PRs to master are only allowed if they come from the lindenb/sarek dev branch.

You do not need to close this PR, you can change the target branch to dev by clicking the "Edit" button at the top of this page.
Note that even after this, the test will continue to show as failing until you push a new commit.

Thanks again for your contribution!

@lindenb lindenb changed the base branch from master to dev August 5, 2024 20:00
Copy link

github-actions bot commented Aug 5, 2024

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

Posted for pipeline commit 6dc5f99

+| ✅ 214 tests passed       |+
#| ❔  11 tests were ignored |#
!| ❗   5 tests had warnings |!

❗ Test warnings:

  • nextflow_config - Config manifest.version should end in dev: 3.5.0
  • 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 base.config: Check the defaults for all processes

❔ Tests ignored:

✅ Tests passed:

Run details

  • nf-core/tools version 3.0.2
  • Run at 2024-12-10 13:04:20

@lindenb
Copy link
Contributor Author

lindenb commented Aug 5, 2024

OK, I merged into dev, let's re-run my tests...

@lindenb
Copy link
Contributor Author

lindenb commented Aug 6, 2024

I think it ok now, nevertheless there is still a pre-commit error but I don't understand the error.

@asp8200
Copy link
Contributor

asp8200 commented Aug 6, 2024

I think it ok now, nevertheless there is still a pre-commit error but I don't understand the error.

prettier is complaining about the following files:

docs/output.md
modules.json
README.md
docs/usage.md

@lindenb
Copy link
Contributor Author

lindenb commented Aug 6, 2024

@asp8200 Thanks, yes I saw this, but was is the error exactly ?

@asp8200
Copy link
Contributor

asp8200 commented Aug 6, 2024

You can run prettier locally on your branch on those above-mentioned files. However, it might also be possible to have a github-action fix it for you. Let's try...

@nf-core-bot fix linting

@asp8200
Copy link
Contributor

asp8200 commented Aug 6, 2024

@nf-core-bot fix linting

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

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

I would put this in samtools/reindex_bam instead of indexcov

@lindenb
Copy link
Contributor Author

lindenb commented Aug 30, 2024

@maxulysse thank you for the review Maxime, I'm currently away from my code, I'll try to have a look at this next week.

Q: this should be set for WGS calling only, what would be the best way/place to set this test ?
Q: should I put this test into the somatic workflow too ? where ?

@maxulysse
Copy link
Member

@maxulysse thank you for the review Maxime, I'm currently away from my code, I'll try to have a look at this next week.

No worries, I know days can be busy

Q: this should be set for WGS calling only, what would be the best way/place to set this test ?
Q: should I put this test into the somatic workflow too ? where ?

I think I would just allow for it if not using the params.wes, so maybe a message in case tool is used with params, similarly to what we do with other warning messages.
And then I'd say adding this test when calling the variant_calling subworkflows.

@lindenb
Copy link
Contributor Author

lindenb commented Sep 3, 2024

@maxulysse back to you, thanks !

docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated
@@ -585,11 +585,13 @@ This list is by no means exhaustive and it will depend on the specific analysis
| [mpileup](https://www.htslib.org/doc/samtools-mpileup.html) | x | x | x | x | x | - |
| [Strelka](https://github.com/Illumina/strelka) | x | x | x | x | - | x |
| [Manta](https://github.com/Illumina/manta) | x | x | x | x | x | x |
| [indexcov](https://github.com/brentp/goleft/tree/master/indexcov) | x | - | x | x | x | x |
Copy link
Contributor

@FriederikeHanssen FriederikeHanssen Dec 10, 2024

Choose a reason for hiding this comment

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

Suggested change
| [indexcov](https://github.com/brentp/goleft/tree/master/indexcov) | x | - | x | x | x | x |
| [indexcov](https://github.com/brentp/goleft/tree/master/indexcov) | x | - | - | x | - | x |

Copy link
Contributor

Choose a reason for hiding this comment

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

@lindenb From the code it looks like tumor-only is currently not covered. Would remove it here for now

Copy link
Contributor

Choose a reason for hiding this comment

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

Going to push this. Need to beat the tools release. Ain't nobody got time for a template update :D

@FriederikeHanssen
Copy link
Contributor

@nf-core-bot fix linting

docs/usage.md Outdated Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

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

this file should be in the image folder

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.

sarek_subway.{png,svg} should be in docs/images

maxulysse
maxulysse previously approved these changes Dec 10, 2024
@FriederikeHanssen FriederikeHanssen merged commit 5c6be78 into nf-core:dev Dec 10, 2024
58 checks passed
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.

6 participants