Skip to content

Varlociraptor integration #1940

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

Open
wants to merge 36 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 33 commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
570f780
First steps to varlociraptor integration
famosab Jul 15, 2025
4fb5e31
Add test file
famosab Jul 15, 2025
da21a7f
update more files
famosab Jul 16, 2025
5d9ff5e
Finalize varlociraptor
famosab Jul 18, 2025
ec86ee4
test
famosab Jul 18, 2025
8b4326f
snap
famosab Jul 18, 2025
dc3cc16
streamline testing and config
famosab Jul 21, 2025
c77fca8
Update tests/.nftignore
famosab Jul 21, 2025
c1f1924
check vcf
famosab Jul 23, 2025
ed80520
Merge branch 'add-varlociraptor' of github.com:nf-core/sarek into add…
famosab Jul 23, 2025
ef56ae8
pre-commit
famosab Jul 23, 2025
61332da
params
famosab Jul 23, 2025
5c34d9a
Add docs
famosab Jul 23, 2025
4cc42f5
update schema
famosab Jul 23, 2025
93fc212
update config
famosab Jul 23, 2025
bd62161
add projectDir
famosab Jul 23, 2025
010997d
simplify collection
famosab Jul 24, 2025
0da0616
change finding of scenario_file
famosab Jul 24, 2025
34d6447
precommit
famosab Jul 24, 2025
0974a76
add germline and tumor_only
famosab Jul 24, 2025
b0dc41d
Merge branch 'add-varlociraptor' of github.com:nf-core/sarek into add…
famosab Jul 24, 2025
2ab8afb
still need to fix the somatic case again
famosab Jul 24, 2025
126ee95
for some reason the VCFSPLIT is not started anymore
famosab Jul 24, 2025
5f9c321
pre-commit
famosab Jul 24, 2025
c8b301e
revert changes to config
famosab Jul 24, 2025
ee3952a
Update usage and output docs
famosab Jul 25, 2025
d568f37
subway and changelog
famosab Jul 25, 2025
59aff8b
Add tools to dependencies
famosab Jul 28, 2025
00d0764
add params
famosab Jul 28, 2025
eec67c9
Correct subway
famosab Jul 28, 2025
e027c32
Merge branch 'dev' into add-varlociraptor
famosab Jul 30, 2025
eaa4971
Merge branch 'dev' into add-varlociraptor
famosab Aug 11, 2025
917ea0e
Merge branch 'dev' into add-varlociraptor
famosab Aug 19, 2025
5eda561
Apply suggestions from code review
famosab Aug 19, 2025
6dbf490
Changelog
famosab Aug 19, 2025
873b57c
Move varlociraptor into its own config
famosab Aug 19, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- [1934](https://github.com/nf-core/sarek/pull/1934) - Add sentieon TNscope for tumour/normal variant calling
- [1938](https://github.com/nf-core/sarek/pull/1938) - Add checks for uniqueness of sample ids and lane ids
- [1939](https://github.com/nf-core/sarek/pull/1939) - Modify config to add readgroups to fq2bam
- [1940](https://github.com/nf-core/sarek/pull/1940) - Add varlociraptor for variant calling
- [1953](https://github.com/nf-core/sarek/pull/1953) - Update freebayes and add QUAL filtering

### Changed
Expand Down Expand Up @@ -51,17 +52,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
| `ensemblvep` | 113.0 | 113.4 |
| `fastp` | 0.23.4 | 0.24.0 |
| `fgbio` | 2.2.1 | 2.4.0 |
| `freebayes` | 1.3.6. | 1.3.10 |
| `freebayes` | 1.3.6 | 1.3.10 |
| `gatk4` | 4.5.0.0 | 4.6.1.0 |
| `mosdepth` | 0.3.8 | 0.3.10 |
| `MuSE` | | 2.1.2 |
| `MultiQC` | 1.25.1 | 1.30 |
| `rbt` | | 0.42.2 |
| `samtools` (in `BWAMEM1_MEM`) | 1.2 | 1.21 |
| `samtools` (in `BWAMEM2_MEM`) | 1.19.2 | 1.21 |
| `samtools` (in `GATK4_MARKDUPLICATES`) | 1.19.2 | 1.21 |
| `sentieon` | 202308.03 | 202503 |
| `tabix` | 1.2 | 1.21 |
| `varlociraptor` | | 8.7.3 |
| `vcflib` | | 1.0.14 |
| `yte` | | 1.9.0 |

### Parameters

Expand Down Expand Up @@ -176,8 +180,10 @@ Akkatjåkkå is another glacier.

### Parameters

| Params | Status |
| ------ | ------ |
| Params | Status |
| ------------------------------ | ------ |
| `--varlocriator_scenario_file` | New |
| `--varlocriator_chunk_size` | New |

## [3.5.0](https://github.com/nf-core/sarek/releases/tag/3.5.0) - Áhkájiegna

Expand Down
4 changes: 4 additions & 0 deletions CITATIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,10 @@

> Eisfeldt J, Vezzi F, Olason P, et al.: TIDDIT, an efficient and comprehensive structural variant caller for massive parallel sequencing data. F1000Res. 2017 May 10;6:664. doi: 10.12688/f1000research.11168.2. eCollection 2017. PubMed PMID: 28781756; PubMed Central PMCID: PMC5521161.
- [Varlociraptor](https://pubmed.ncbi.nlm.nih.gov/32345333/)

> Köster, J., Dijkstra, L.J., Marschall, T. et al. Varlociraptor: enhancing sensitivity and controlling false discovery rate in somatic indel discovery. Genome Biol 21, 98 (2020). https://doi.org/10.1186/s13059-020-01993-6
- [VCFTools](https://pubmed.ncbi.nlm.nih.gov/21653522/)

> Danecek P, Auton A, Abecasis G, et al.: The variant call format and VCFtools. Bioinformatics. 2011 Aug 1;27(15):2156-8. doi: 10.1093/bioinformatics/btr330. Epub 2011 Jun 7. PubMed PMID: 21653522; PubMed Central PMCID: PMC3137218.
Expand Down
34 changes: 34 additions & 0 deletions assets/varlociraptor_somatic_with_priors.yte.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
species:
heterozygosity: 0.001
germline-mutation-rate: 1e-3
ploidy:
male:
all: 2
X: 1
Y: 1
female:
all: 2
X: 2
Y: 0
genome-size: 3.5e9

samples:
tumor:
sex: ?sex_string
somatic-effective-mutation-rate: 1e-6
inheritance:
clonal:
from: normal
somatic: true
contamination:
by: normal
fraction: 0.1
normal:
sex: ?sex_string
somatic-effective-mutation-rate: 1e-10

events:
somatic_tumor_high: "normal:0.0 & tumor:[0.1,1.0]"
somatic_tumor_low: "normal:0.0 & tumor:]0.0,0.1["
somatic_normal: "normal:]0.0,0.5["
germline: "normal:0.5 | normal:1.0"
139 changes: 139 additions & 0 deletions conf/modules/post_variant_calling.config
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,143 @@ process {
pattern: "*.tbi"
]
}

// VARLOCIRAPTOR ALL
withName: 'FILL_SCENARIO_FILE' {
ext.prefix = { "${meta.id}.scenario.varlociraptor" }
publishDir = [
mode: params.publish_dir_mode,
path: { "${params.outdir}/variant_calling/varlociraptor/${meta.id}/" },
]
}

//
// VCF_VARLOCIRAPTOR_GERMLINE and VCF_VARLOCIRAPTOR_TUMOR_ONLY MODULES
//
withName: 'VARLOCIRAPTOR_ESTIMATEALIGNMENTPROPERTIES' {
ext.prefix = { "${meta.id}" }
publishDir = [
mode: params.publish_dir_mode,
path: { "${params.outdir}/variant_calling/varlociraptor/${meta.id}/" },
]
}

withName: 'RBT_VCFSPLIT' {
ext.prefix = { "${meta.id}.${meta.variantcaller}.split" }
publishDir = [
mode: params.publish_dir_mode,
path: { "${params.outdir}/variant_calling/varlociraptor/${meta.id}/" },
]
}

withName: 'VARLOCIRAPTOR_PREPROCESS' {
ext.prefix = { "${meta.id}.${meta.variantcaller}.preprocess.${meta.chunk}" }
publishDir = [
mode: params.publish_dir_mode,
path: { "${params.outdir}/variant_calling/varlociraptor/${meta.id}/" },
]
}

withName: 'NFCORE_SAREK:SAREK:POST_VARIANTCALLING:VCF_VARLOCIRAPTOR_GERMLINE:VARLOCIRAPTOR_CALLVARIANTS|NFCORE_SAREK:SAREK:POST_VARIANTCALLING:VCF_VARLOCIRAPTOR_TUMOR_ONLY:VARLOCIRAPTOR_CALLVARIANTS' {
ext.prefix = { "${meta.id}.${meta.variantcaller}.call.${meta.chunk}" }
publishDir = [
mode: params.publish_dir_mode,
path: { "${params.outdir}/variant_calling/varlociraptor/${meta.id}/" },
]
}

withName: 'NFCORE_SAREK:SAREK:POST_VARIANTCALLING:VCF_VARLOCIRAPTOR_GERMLINE:SORT_CALLED_CHUNKS|NFCORE_SAREK:SAREK:POST_VARIANTCALLING:VCF_VARLOCIRAPTOR_TUMOR_ONLY:SORT_CALLED_CHUNKS' {
ext.prefix = { "${meta.id}.${meta.variantcaller}.sort.${meta.chunk}" }
ext.args = { '--output-type z --write-index=tbi' }
publishDir = [
mode: params.publish_dir_mode,
path: { "${params.outdir}/variant_calling/varlociraptor/${meta.id}/" },
]
}

withName: 'NFCORE_SAREK:SAREK:POST_VARIANTCALLING:VCF_VARLOCIRAPTOR_GERMLINE:MERGE_CALLED_CHUNKS|NFCORE_SAREK:SAREK:POST_VARIANTCALLING:VCF_VARLOCIRAPTOR_TUMOR_ONLY:MERGE_CALLED_CHUNKS' {
ext.prefix = { "${meta.id}.${meta.variantcaller}.varlociraptor" }
ext.args = { '--allow-overlaps --output-type z --write-index=tbi' }
publishDir = [
mode: params.publish_dir_mode,
path: { "${params.outdir}/variant_calling/varlociraptor/" },
]
}

//
// VCF_VARLOCIRAPTOR_SOMATIC MODULES
//
withName: 'NFCORE_SAREK:SAREK:POST_VARIANTCALLING:VCF_VARLOCIRAPTOR_SOMATIC:ALIGNMENTPROPERTIES_NORMAL' {
ext.prefix = { "${meta.normal_id}" }
publishDir = [
mode: params.publish_dir_mode,
path: { "${params.outdir}/variant_calling/varlociraptor/${meta.normal_id}/" },
]
}

withName: 'NFCORE_SAREK:SAREK:POST_VARIANTCALLING:VCF_VARLOCIRAPTOR_SOMATIC:VCFSPLIT_NORMAL' {
ext.prefix = { "${meta.normal_id}.${meta.variantcaller}.split" }
publishDir = [
mode: params.publish_dir_mode,
path: { "${params.outdir}/variant_calling/varlociraptor/${meta.normal_id}/" },
]
}

withName: 'NFCORE_SAREK:SAREK:POST_VARIANTCALLING:VCF_VARLOCIRAPTOR_SOMATIC:PREPROCESS_NORMAL' {
ext.prefix = { "${meta.normal_id}.${meta.variantcaller}.preprocess.${meta.chunk}" }
publishDir = [
mode: params.publish_dir_mode,
path: { "${params.outdir}/variant_calling/varlociraptor/${meta.normal_id}/" },
]
}

withName: 'NFCORE_SAREK:SAREK:POST_VARIANTCALLING:VCF_VARLOCIRAPTOR_SOMATIC:ALIGNMENTPROPERTIES_TUMOR' {
ext.prefix = { "${meta.tumor_id}" }
publishDir = [
mode: params.publish_dir_mode,
path: { "${params.outdir}/variant_calling/varlociraptor/${meta.tumor_id}/" },
]
}

withName: 'NFCORE_SAREK:SAREK:POST_VARIANTCALLING:VCF_VARLOCIRAPTOR_SOMATIC:VCFSPLIT_TUMOR' {
ext.prefix = { "${meta.tumor_id}.${meta.variantcaller}.split" }
publishDir = [
mode: params.publish_dir_mode,
path: { "${params.outdir}/variant_calling/varlociraptor/${meta.tumor_id}/" },
]
}

withName: 'NFCORE_SAREK:SAREK:POST_VARIANTCALLING:VCF_VARLOCIRAPTOR_SOMATIC:PREPROCESS_TUMOR' {
ext.prefix = { "${meta.tumor_id}.${meta.variantcaller}.preprocess.${meta.chunk}" }
publishDir = [
mode: params.publish_dir_mode,
path: { "${params.outdir}/variant_calling/varlociraptor/${meta.tumor_id}/" },
]
}

withName: 'NFCORE_SAREK:SAREK:POST_VARIANTCALLING:VCF_VARLOCIRAPTOR_SOMATIC:VARLOCIRAPTOR_CALLVARIANTS' {
ext.prefix = { "${meta.id}.${meta.variantcaller}.call.${meta.chunk}" }
publishDir = [
mode: params.publish_dir_mode,
path: { "${params.outdir}/variant_calling/varlociraptor/${meta.id}/" },
]
}

withName: 'NFCORE_SAREK:SAREK:POST_VARIANTCALLING:VCF_VARLOCIRAPTOR_SOMATIC:SORT_CALLED_CHUNKS' {
ext.prefix = { "${meta.id}.${meta.variantcaller}.sort.${meta.chunk}" }
ext.args = { '--output-type z --write-index=tbi' }
publishDir = [
mode: params.publish_dir_mode,
path: { "${params.outdir}/variant_calling/varlociraptor/${meta.id}/" },
]
}

withName: 'NFCORE_SAREK:SAREK:POST_VARIANTCALLING:VCF_VARLOCIRAPTOR_SOMATIC:MERGE_CALLED_CHUNKS' {
ext.prefix = { "${meta.id}.${meta.variantcaller}.varlociraptor" }
ext.args = { '--allow-overlaps --output-type z --write-index=tbi' }
publishDir = [
mode: params.publish_dir_mode,
path: { "${params.outdir}/variant_calling/varlociraptor/" },
]
}
}
Binary file modified docs/images/sarek_subway.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading