-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathro-crate-metadata.json
360 lines (360 loc) · 25.4 KB
/
ro-crate-metadata.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
{
"@context": [
"https://w3id.org/ro/crate/1.1/context",
{
"GithubService": "https://w3id.org/ro/terms/test#GithubService",
"JenkinsService": "https://w3id.org/ro/terms/test#JenkinsService",
"PlanemoEngine": "https://w3id.org/ro/terms/test#PlanemoEngine",
"TestDefinition": "https://w3id.org/ro/terms/test#TestDefinition",
"TestInstance": "https://w3id.org/ro/terms/test#TestInstance",
"TestService": "https://w3id.org/ro/terms/test#TestService",
"TestSuite": "https://w3id.org/ro/terms/test#TestSuite",
"TravisService": "https://w3id.org/ro/terms/test#TravisService",
"definition": "https://w3id.org/ro/terms/test#definition",
"engineVersion": "https://w3id.org/ro/terms/test#engineVersion",
"instance": "https://w3id.org/ro/terms/test#instance",
"resource": "https://w3id.org/ro/terms/test#resource",
"runsOn": "https://w3id.org/ro/terms/test#runsOn"
}
],
"@graph": [
{
"@id": "./",
"@type": "Dataset",
"creativeWorkStatus": "Stable",
"datePublished": "2025-03-06T15:26:52+00:00",
"description": "<h1>\n <picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"docs/images/nf-core-variantbenchmarking_logo_dark.png\">\n <img alt=\"nf-core/variantbenchmarking\" src=\"docs/images/nf-core-variantbenchmarking_logo_light.png\">\n </picture>\n</h1>\n\n[](https://github.com/nf-core/variantbenchmarking/actions/workflows/ci.yml)\n[](https://github.com/nf-core/variantbenchmarking/actions/workflows/linting.yml)[](https://nf-co.re/variantbenchmarking/results)[](https://doi.org/10.5281/zenodo.14916661)\n[](https://www.nf-test.com)\n\n[](https://www.nextflow.io/)\n[](https://docs.conda.io/en/latest/)\n[](https://www.docker.com/)\n[](https://sylabs.io/docs/)\n[](https://cloud.seqera.io/launch?pipeline=https://github.com/nf-core/variantbenchmarking)\n\n[](https://nfcore.slack.com/channels/variantbenchmarking)[](https://twitter.com/nf_core)[](https://mstdn.science/@nf_core)[](https://www.youtube.com/c/nf-core)\n\n## Introduction\n\n**nf-core/variantbenchmarking** is designed to evaluate and validate the accuracy of variant calling methods in genomic research. Initially, the pipeline is tuned well for available gold standard truth sets (for example, Genome in a Bottle and SEQC2 samples) but it can be used to compare any two variant calling results. The workflow provides benchmarking tools for small variants including SNVs and INDELs, Structural Variants (SVs) and Copy Number Variations (CNVs) for germline and somatic analysis.\n\nThe pipeline is built using [Nextflow](https://www.nextflow.io), a workflow tool to run tasks across multiple compute infrastructures in a very portable manner. It uses Docker/Singularity containers making installation trivial and results highly reproducible. The [Nextflow DSL2](https://www.nextflow.io/docs/latest/dsl2.html) implementation of this pipeline uses one container per process which makes it much easier to maintain and update software dependencies. Where possible, these processes have been submitted to and installed from [nf-core/modules](https://github.com/nf-core/modules) in order to make them available to all nf-core pipelines, and to everyone within the Nextflow community!\n\n<p align=\"center\">\n <img title=\"variantbenchmarking metro map\" src=\"docs/images/variantbenchmarking_metromap.png\" width=100%>\n</p>\n\nThe workflow involves several key processes to ensure reliable and reproducible results as follows:\n\n### Standardization and normalization of variants:\n\nThis initial step ensures consistent formatting and alignment of variants in test and truth VCF files for accurate comparison.\n\n- Subsample if input test vcf is multisample ([bcftools view](https://samtools.github.io/bcftools/bcftools.html#view))\n- Homogenization of multi-allelic variants, MNPs and SVs (including imprecise paired breakends and single breakends) ([variant-extractor](https://github.com/EUCANCan/variant-extractor))\n- Reformatting test VCF files from different SV callers ([svync](https://github.com/nvnieuwk/svync))\n- Rename sample names in test and truth VCF files ([bcftools reheader](https://samtools.github.io/bcftools/bcftools.html#reheader))\n- Splitting multi-allelic variants in test and truth VCF files ([bcftools norm](https://samtools.github.io/bcftools/bcftools.html#norm))\n- Deduplication of variants in test and truth VCF files ([bcftools norm](https://samtools.github.io/bcftools/bcftools.html#norm))\n- Left aligning of variants in test and truth VCF files ([bcftools norm](https://samtools.github.io/bcftools/bcftools.html#norm))\n- Use prepy in order to normalize test files. This option is only applicable for happy benchmarking of germline analysis ([prepy](https://github.com/Illumina/hap.py/tree/master))\n- Split SNVs and indels if the given test VCF contains both. This is only applicable for somatic analysis ([bcftools view](https://samtools.github.io/bcftools/bcftools.html#view))\n\n### Filtering options:\n\nApplying filtering on the process of benchmarking itself might makes it impossible to compare different benchmarking strategies. Therefore, for whom like to compare benchmarking methods this subworkflow aims to provide filtering options for variants.\n\n- Filtration of contigs ([bcftools view](https://samtools.github.io/bcftools/bcftools.html#view))\n- Include or exclude SNVs and INDELs ([bcftools filter](https://samtools.github.io/bcftools/bcftools.html#filter))\n- Size and quality filtering for SVs ([SURVIVOR filter](https://github.com/fritzsedlazeck/SURVIVOR/wiki))\n\n### Liftover of vcfs:\n\nThis sub-workflow provides option to convert genome coordinates of truth VCF and test VCFs and high confidence BED file to a new assembly. Golden standard truth files are build upon specific reference genomes which makes the necessity of lifting over depending on the test VCF in query. Lifting over one or more test VCFs is also possible.\n\n- Create sequence dictionary for the reference ([picard CreateSequenceDictionary](https://gatk.broadinstitute.org/hc/en-us/articles/360037068312-CreateSequenceDictionary-Picard)). This file can be saved and reused.\n- Lifting over VCFs ([picard LiftoverVcf](https://gatk.broadinstitute.org/hc/en-us/articles/360037060932-LiftoverVcf-Picard))\n- Lifting over high confidence coordinates ([UCSC liftover](http://hgdownload.cse.ucsc.edu/admin/exe))\n\n### Statistical inference of input test and truth variants:\n\nThis step provides insights into the distribution of variants before benchmarking by extracting variant statistics:.\n\n- SNVs, INDELs and complex variants ([bcftools stats](https://samtools.github.io/bcftools/bcftools.html#stats))\n- SVs by type ([SURVIVOR stats](https://github.com/fritzsedlazeck/SURVIVOR/wiki))\n\n### Benchmarking of variants:\n\nActual benchmarking of variants are split between SVs and small variants:\n\nAvailable methods for germline and somatic _structural variant (SV)_ benchmarking are:\n\n- Truvari ([truvari bench](https://github.com/acenglish/truvari/wiki/bench))\n- SVanalyzer ([svanalyzer benchmark](https://github.com/nhansen/SVanalyzer/blob/master/docs/svbenchmark.rst))\n\n> [!NOTE]\n> Please note that there is no somatic specific tool for SV benchmarking in this pipeline.\n\nAvailable methods for germline and somatic _CNVs (copy number variations)_ are:\n\n- Truvari ([truvari bench](https://github.com/acenglish/truvari/wiki/bench))\n- Wittyer ([witty.er](https://github.com/Illumina/witty.er/tree/master))\n\n> [!NOTE]\n> Please note that there is no somatic specific tool for CNV benchmarking in this pipeline.\n\nAvailable methods for *small variants: SNVs and INDEL*s:\n\n- Germline variant benchmarking using ([rtg vcfeval](https://realtimegenomics.com/products/rtg-tools))\n- Germline variant benchmarking using ([hap.py](https://github.com/Illumina/hap.py/blob/master/doc/happy.md))\n- Somatic variant benchmarking using ([som.py](https://github.com/Illumina/hap.py/tree/master?tab=readme-ov-file#sompy))\n\n### Intersection of benchmark regions:\n\nIntersecting test and truth BED regions produces benchmark metrics. Intersection analysis is especially recommended for _CNV benchmarking_ where result reports may variate per tool.\n\n- Convert SV or CNV VCF file to BED file, if no regions file is provided for test case using ([SVTK vcf2bed](https://github.com/broadinstitute/gatk-sv/blob/main/src/svtk/scripts/svtk))\n- Convert VCF file to BED file, if no regions file is provided for test case using ([Bedops convert2bed](https://bedops.readthedocs.io/en/latest/content/reference/file-management/conversion/convert2bed.html#convert2bed))\n- Intersect the regions and gether benchmarking statistics using ([bedtools intersect](https://bedtools.readthedocs.io/en/latest/content/tools/intersect.html))\n\n### Comparison of benchmarking results per TP, FP and FN files\n\nIt is essential to compare benchmarking results in order to infer uniquely or commonly seen TPs, FPs and FNs.\n\n- Merging TP, FP and FN results for happy, rtgtools and sompy ([bcftools merge](https://samtools.github.io/bcftools/bcftools.html#merge))\n- Merging TP, FP and FN results for Truvari and SVanalyzer ([SURVIVOR merge](https://github.com/fritzsedlazeck/SURVIVOR/wiki))\n- Conversion of VCF files to CSV to infer common and unique variants per caller (python script)\n\n### Reporting of benchmark results\n\nThe generation of comprehensive report that consolidates all benchmarking results.\n\n- Merging summary statistics per benchmarking tool (python script)\n- Plotting benchmark metrics per benchmarking tool (R script)\n- Create visual HTML report for the integration of NCBENCH ([datavzrd](https://datavzrd.github.io/docs/index.html))\n- Apply _MultiQC_ to visualize results\n\n## Usage\n\n> [!NOTE]\n> If you are new to Nextflow and nf-core, please refer to [this page](https://nf-co.re/docs/usage/installation) on how to set-up Nextflow. Make sure to [test your setup](https://nf-co.re/docs/usage/introduction#how-to-run-a-pipeline) with `-profile test` before running the workflow on actual data.\n\nFirst, prepare a samplesheet with your input data that looks as follows:\n\n`samplesheet.csv`:\n\n```csv\nid,test_vcf,caller\ntest1,test1.vcf.gz,delly\ntest2,test2.vcf,gatk\ntest3,test3.vcf.gz,cnvkit\n```\n\nEach row represents a vcf file (test-query file). For each vcf file and variant calling method (caller) have to be defined.\n\nUser _has to provide truth_vcf and truth_id in config files_.\n\n> [!NOTE]\n> There are publicly available truth sources. For germline analysis, it is common to use [genome in a bottle (GiAB)](https://www.nist.gov/programs-projects/genome-bottle) variants. There are variate type of golden truths and high confidence regions for hg37 and hg38 references. Please select and use carefully.\n> For somatic analysis, [SEQC2 project](https://sites.google.com/view/seqc2/home/data-analysis/high-confidence-somatic-snv-and-indel-v1-2) released SNV, INDEL and CNV regions. One, can select and use those files.\n\nFor more details and further functionality, please refer to the [usage documentation](https://nf-co.re/variantbenchmarking/usage) and the [parameter documentation](https://nf-co.re/variantbenchmarking/parameters).\n\nNow, you can run the pipeline using:\n\n```bash\nnextflow run nf-core/variantbenchmarking \\\n -profile <docker/singularity/.../institute> \\\n --input samplesheet.csv \\\n --outdir <OUTDIR> \\\n --genome GRCh37 \\\n --analysis germline \\\n --truth_id HG002 \\\n --truth_vcf truth.vcf.gz\n```\n\n> [!WARNING]\n> Please provide pipeline parameters via the CLI or Nextflow `-params-file` option. Custom config files including those provided by the `-c` Nextflow option can be used to provide any configuration _**except for parameters**_; see [docs](https://nf-co.re/docs/usage/getting_started/configuration#custom-configuration-files).\n> Conda profile is not available for SVanalyzer (SVBenchmark) tool, if you are planing to use the tool either choose docker or singularity.\n\n## Pipeline output\n\nTo see the results of an example test run with a full size dataset refer to the [results](https://nf-co.re/variantbenchmarking/results) tab on the nf-core website pipeline page.\nFor more details about the output files and reports, please refer to the\n[output documentation](https://nf-co.re/variantbenchmarking/output).\n\nThis pipeline outputs benchmarking results per method besides to the inferred and compared statistics.\n\n## Credits\n\nnf-core/variantbenchmarking was originally written by K\u00fcbra Narc\u0131 ([@kubranarci](https://github.com/kubranarci)) as a part of benchmarking studies in German Human Genome Phenome Archieve Project ([GHGA](https://www.ghga.de/)).\n\nWe thank the following people for their extensive assistance in the development of this pipeline:\n\n- Nicolas Vannieuwkerke ([@nvnienwk](https://github.com/nvnieuwk)),\n- Maxime Garcia ([@maxulysse](https://github.com/maxulysse)),\n- Sameesh Kher ([@khersameesh24](https://github.com/khersameesh24))\n- Florian Heyl ([@heylf](https://github.com/heyl))\n- Elad Herz ([@EladH1](https://github.com/EladH1))\n\n## Acknowledgements\n\n<a href=\"https://www.ghga.de/\">\n <img src=\"docs/images/GHGA_short_Logo_orange.png\" alt=\"GHGA\" width=\"200\"/>\n</a>\n\n## Contributions and Support\n\nIf you would like to contribute to this pipeline, please see the [contributing guidelines](.github/CONTRIBUTING.md).\n\nFor further information or help, don't hesitate to get in touch on the [Slack `#variantbenchmarking` channel](https://nfcore.slack.com/channels/variantbenchmarking) (you can join with [this invite](https://nf-co.re/join/slack)).\n\n## Citations\n\nIf you use nf-core/variantbenchmarking for your analysis, please cite it using the following doi: [110.5281/zenodo.14916661](https://doi.org/10.5281/zenodo.14916661)\n\nAn extensive list of references for the tools used by the pipeline can be found in the [`CITATIONS.md`](CITATIONS.md) file.\n\nYou can cite the `nf-core` publication as follows:\n\n> **The nf-core framework for community-curated bioinformatics pipelines.**\n>\n> Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.\n>\n> _Nat Biotechnol._ 2020 Feb 13. doi: [10.1038/s41587-020-0439-x](https://dx.doi.org/10.1038/s41587-020-0439-x).\n",
"hasPart": [
{
"@id": "main.nf"
},
{
"@id": "assets/"
},
{
"@id": "bin/"
},
{
"@id": "conf/"
},
{
"@id": "docs/"
},
{
"@id": "docs/images/"
},
{
"@id": "modules/"
},
{
"@id": "modules/local/"
},
{
"@id": "modules/nf-core/"
},
{
"@id": "workflows/"
},
{
"@id": "subworkflows/"
},
{
"@id": "nextflow.config"
},
{
"@id": "README.md"
},
{
"@id": "nextflow_schema.json"
},
{
"@id": "CHANGELOG.md"
},
{
"@id": "LICENSE"
},
{
"@id": "CODE_OF_CONDUCT.md"
},
{
"@id": "CITATIONS.md"
},
{
"@id": "modules.json"
},
{
"@id": "docs/usage.md"
},
{
"@id": "docs/output.md"
},
{
"@id": ".nf-core.yml"
},
{
"@id": ".pre-commit-config.yaml"
},
{
"@id": ".prettierignore"
}
],
"isBasedOn": "https://github.com/nf-core/variantbenchmarking",
"license": "MIT",
"mainEntity": {
"@id": "main.nf"
},
"mentions": [
{
"@id": "#39e25be6-2fa8-42c1-8a87-739f3cc04410"
}
],
"name": "nf-core/variantbenchmarking"
},
{
"@id": "ro-crate-metadata.json",
"@type": "CreativeWork",
"about": {
"@id": "./"
},
"conformsTo": [
{
"@id": "https://w3id.org/ro/crate/1.1"
},
{
"@id": "https://w3id.org/workflowhub/workflow-ro-crate/1.0"
}
]
},
{
"@id": "main.nf",
"@type": [
"File",
"SoftwareSourceCode",
"ComputationalWorkflow"
],
"creator": [
{
"@id": "https://orcid.org/0000-0002-3532-2152"
},
{
"@id": "https://orcid.org/0009-0003-5619-1555"
},
{
"@id": "#[email protected]"
}
],
"dateCreated": "",
"dateModified": "2025-03-06T15:26:52Z",
"dct:conformsTo": "https://bioschemas.org/profiles/ComputationalWorkflow/1.0-RELEASE/",
"keywords": [
"nf-core",
"nextflow",
"benchmark",
"draft",
"structural-variants",
"variant-calling"
],
"license": [
"MIT"
],
"name": [
"nf-core/variantbenchmarking"
],
"programmingLanguage": {
"@id": "https://w3id.org/workflowhub/workflow-ro-crate#nextflow"
},
"sdPublisher": {
"@id": "https://nf-co.re/"
},
"url": [
"https://github.com/nf-core/variantbenchmarking",
"https://nf-co.re/variantbenchmarking/1.1.0/"
],
"version": [
"1.1.0"
]
},
{
"@id": "https://w3id.org/workflowhub/workflow-ro-crate#nextflow",
"@type": "ComputerLanguage",
"identifier": {
"@id": "https://www.nextflow.io/"
},
"name": "Nextflow",
"url": {
"@id": "https://www.nextflow.io/"
},
"version": "!>=24.04.2"
},
{
"@id": "#39e25be6-2fa8-42c1-8a87-739f3cc04410",
"@type": "TestSuite",
"instance": [
{
"@id": "#a0515f06-5397-4caa-981e-459d947e2165"
}
],
"mainEntity": {
"@id": "main.nf"
},
"name": "Test suite for nf-core/variantbenchmarking"
},
{
"@id": "#a0515f06-5397-4caa-981e-459d947e2165",
"@type": "TestInstance",
"name": "GitHub Actions workflow for testing nf-core/variantbenchmarking",
"resource": "repos/nf-core/variantbenchmarking/actions/workflows/ci.yml",
"runsOn": {
"@id": "https://w3id.org/ro/terms/test#GithubService"
},
"url": "https://api.github.com"
},
{
"@id": "https://w3id.org/ro/terms/test#GithubService",
"@type": "TestService",
"name": "Github Actions",
"url": {
"@id": "https://github.com"
}
},
{
"@id": "assets/",
"@type": "Dataset",
"description": "Additional files"
},
{
"@id": "bin/",
"@type": "Dataset",
"description": "Scripts that must be callable from a pipeline process"
},
{
"@id": "conf/",
"@type": "Dataset",
"description": "Configuration files"
},
{
"@id": "docs/",
"@type": "Dataset",
"description": "Markdown files for documenting the pipeline"
},
{
"@id": "docs/images/",
"@type": "Dataset",
"description": "Images for the documentation files"
},
{
"@id": "modules/",
"@type": "Dataset",
"description": "Modules used by the pipeline"
},
{
"@id": "modules/local/",
"@type": "Dataset",
"description": "Pipeline-specific modules"
},
{
"@id": "modules/nf-core/",
"@type": "Dataset",
"description": "nf-core modules"
},
{
"@id": "workflows/",
"@type": "Dataset",
"description": "Main pipeline workflows to be executed in main.nf"
},
{
"@id": "subworkflows/",
"@type": "Dataset",
"description": "Smaller subworkflows"
},
{
"@id": "nextflow.config",
"@type": "File",
"description": "Main Nextflow configuration file"
},
{
"@id": "README.md",
"@type": "File",
"description": "Basic pipeline usage information"
},
{
"@id": "nextflow_schema.json",
"@type": "File",
"description": "JSON schema for pipeline parameter specification"
},
{
"@id": "CHANGELOG.md",
"@type": "File",
"description": "Information on changes made to the pipeline"
},
{
"@id": "LICENSE",
"@type": "File",
"description": "The license - should be MIT"
},
{
"@id": "CODE_OF_CONDUCT.md",
"@type": "File",
"description": "The nf-core code of conduct"
},
{
"@id": "CITATIONS.md",
"@type": "File",
"description": "Citations needed when using the pipeline"
},
{
"@id": "modules.json",
"@type": "File",
"description": "Version information for modules from nf-core/modules"
},
{
"@id": "docs/usage.md",
"@type": "File",
"description": "Usage documentation"
},
{
"@id": "docs/output.md",
"@type": "File",
"description": "Output documentation"
},
{
"@id": ".nf-core.yml",
"@type": "File",
"description": "nf-core configuration file, configuring template features and linting rules"
},
{
"@id": ".pre-commit-config.yaml",
"@type": "File",
"description": "Configuration file for pre-commit hooks"
},
{
"@id": ".prettierignore",
"@type": "File",
"description": "Ignore file for prettier"
},
{
"@id": "https://nf-co.re/",
"@type": "Organization",
"name": "nf-core",
"url": "https://nf-co.re/"
},
{
"@id": "https://orcid.org/0000-0002-3532-2152",
"@type": "Person",
"email": "[email protected]",
"name": "K\u00fcbra Narc\u0131"
},
{
"@id": "https://orcid.org/0009-0003-5619-1555",
"@type": "Person",
"email": "[email protected]",
"name": "Nicolas Vannieuwkerke"
},
{
"@id": "#[email protected]",
"@type": "Person",
"email": "[email protected]",
"name": "Maxime U Garcia"
}
]
}