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

FEAT: Use annotation-cache and update VEP to v110 #1122

Merged
merged 24 commits into from
Aug 17, 2023

Conversation

maxulysse
Copy link
Member

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).
  • 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 20, 2023

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 6ef8a46

+| ✅ 151 tests passed       |+
#| ❔   9 tests were ignored |#
!| ❗   2 tests had warnings |!

❗ Test warnings:

❔ Tests ignored:

✅ Tests passed:

Run details

  • nf-core/tools version 2.9
  • Run at 2023-08-17 12:46:26

@maxulysse maxulysse added this to the 3.3 milestone Jun 22, 2023
@maxulysse maxulysse marked this pull request as ready for review July 4, 2023 17:09
"use_annotation_cache_keys": {
"type": "boolean",
"fa_icon": "fas fa-toolbox",
"description": "Use annotation cache keys for snpeff_cache and vep_cache.",
Copy link
Contributor

Choose a reason for hiding this comment

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

can we get a help text with a bit more explanation

Copy link
Contributor

Choose a reason for hiding this comment

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

like i am unsure now, if this referes to the new s3 bucket or if I want to define some cache locally or so

Copy link
Member Author

Choose a reason for hiding this comment

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

yeah, basically that's because of how snpeff and vep store data, they're made for HPC, and I'm storing on cloud.
Plan would be to extrapolate that in the docs.
But I need to build a website for that.

Copy link
Contributor

Choose a reason for hiding this comment

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

ok awesome :)

@@ -128,6 +128,10 @@ if (params.tools && (params.tools.split(',').contains('ascat') || params.tools.s
}
}

if ((params.download_cache) && (params.snpeff_cache || params.vep_cache)) {
error("Please specify either `--download_cache` or `--snpeff_cache`, `--vep_cache`.\nhttps://nf-co.re/sarek/dev/usage#how-to-customise-snpeff-and-vep-annotation")
Copy link
Contributor

Choose a reason for hiding this comment

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

did you update these docs already? Quick question how does this work for a cluster wide setup? I am thinking it would make sense to instruct users to predownload this, same as for igenomes and then supply the cache location (maybe sarek specific config specific config, to keep download costs low in terms of time and storage space for users)

Copy link
Member Author

Choose a reason for hiding this comment

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

yeah, for a regular HPC, that depends if you build yourself or if you copy annotation_cache.
If you build locally, then no issue, just set up use_annotation_cache_keys to false.
If just basic mirror of annotation_cache then use_annotation_cache_keys should be set to true.
But for now, no other options.

Copy link
Contributor

@FriederikeHanssen FriederikeHanssen left a comment

Choose a reason for hiding this comment

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

❤️ really nice. I think a few more docs, and the changelog

nextflow.config Outdated Show resolved Hide resolved
nextflow.config Outdated Show resolved Hide resolved
@asp8200 asp8200 changed the title FEAT: Use annotation-cache FEAT: Use annotation-cache and update VEP to v110 Aug 9, 2023
@asp8200 asp8200 mentioned this pull request Aug 9, 2023
10 tasks
Copy link
Contributor

@FriederikeHanssen FriederikeHanssen left a comment

Choose a reason for hiding this comment

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

looks good, just some minor things about the versio

conf/test.config Show resolved Hide resolved
conf/test/cache.config Outdated Show resolved Hide resolved
conf/test.config Outdated Show resolved Hide resolved
modules/nf-core/ensemblvep/download/main.nf Outdated Show resolved Hide resolved
maxulysse and others added 3 commits August 17, 2023 14:14
Co-authored-by: Friederike Hanssen <Friederike.hanssen@qbic.uni-tuebingen.de>
@maxulysse maxulysse merged commit 2934fcf into nf-core:dev Aug 17, 2023
27 checks passed
@maxulysse maxulysse deleted the annotation_cache branch August 17, 2023 13:09
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.

3 participants