forked from genomic-medicine-sweden/nallo
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathnextflow_schema.json
More file actions
965 lines (965 loc) · 51 KB
/
nextflow_schema.json
File metadata and controls
965 lines (965 loc) · 51 KB
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
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/genomic-medicine-sweden/nallo/master/nextflow_schema.json",
"title": "genomic-medicine-sweden/nallo pipeline parameters",
"description": "Long-read variant calling pipeline",
"type": "object",
"$defs": {
"workflow_skip_options": {
"title": "Workflow skip options",
"type": "object",
"description": "Allows skipping certain parts of the pipeline",
"default": "",
"properties": {
"skip_annotate_paralogs": {
"type": "boolean",
"description": "Skip paralogs (Paraphase) annotation",
"fa_icon": "fas fa-fast-forward",
"default": false
},
"skip_qc": {
"type": "boolean",
"fa_icon": "fas fa-fast-forward",
"description": "Skip QC of reads",
"default": false
},
"skip_snv_calling": {
"type": "boolean",
"description": "Skip short variant calling",
"fa_icon": "fas fa-fast-forward",
"default": false
},
"skip_genome_assembly": {
"type": "boolean",
"description": "Skip genome assembly and assembly variant calling",
"fa_icon": "fas fa-fast-forward",
"default": false
},
"skip_alignment": {
"type": "boolean",
"description": "Skip read mapping (alignment)",
"fa_icon": "fas fa-fast-forward",
"default": false
},
"skip_methylation_calling": {
"type": "boolean",
"description": "Skip methylation calling",
"fa_icon": "fas fa-fast-forward",
"default": false
},
"skip_repeat_calling": {
"type": "boolean",
"description": "Skip tandem repeat calling",
"fa_icon": "fas fa-fast-forward",
"default": false
},
"skip_repeat_annotation": {
"type": "boolean",
"description": "Skip tandem repeat annotation",
"fa_icon": "fas fa-fast-forward",
"default": false
},
"skip_chromograph": {
"type": "boolean",
"fa_icon": "fas fa-fast-forward",
"description": "Skip chromograph image generation. True if both plot_chromograph_coverage and plot_chromograph_autozygosity are set to false."
},
"skip_peddy": {
"type": "boolean",
"fa_icon": "fas fa-fast-forward",
"description": "Skip peddy",
"default": false
},
"skip_sambamba_depth": {
"type": "boolean",
"fa_icon": "fas fa-fast-forward",
"description": "Skip sambamba depth. True unless `--sambamba_regions` is provided."
},
"skip_phasing": {
"type": "boolean",
"fa_icon": "fas fa-fast-forward",
"description": "Skip phasing of variants and haplotagging of reads",
"default": false
},
"skip_snv_annotation": {
"type": "boolean",
"description": "Skip short variant annotation",
"default": false
},
"skip_sv_calling": {
"type": "boolean",
"description": "Skip structural variant calling",
"default": false
},
"skip_sv_annotation": {
"type": "boolean",
"description": "Skip structural variant annotation",
"default": false
},
"skip_call_paralogs": {
"type": "boolean",
"description": "Skip the calling of specific paralogous genes",
"default": false
},
"skip_rank_variants": {
"type": "boolean",
"description": "Skip ranking of short variants",
"default": false
},
"skip_prepare_gens_input": {
"type": "boolean",
"description": "Skip preparing input data for Gens",
"default": false
}
},
"fa_icon": "fas fa-american-sign-language-interpreting"
},
"input_output_options": {
"title": "Input/output options",
"type": "object",
"fa_icon": "fas fa-terminal",
"description": "Define where the pipeline should find input data and save output data.",
"required": ["input", "outdir"],
"properties": {
"input": {
"type": "string",
"format": "file-path",
"exists": true,
"schema": "assets/schema_input.json",
"mimetype": "text/csv",
"pattern": "^\\S+\\.csv$",
"description": "Path to comma-separated file containing information about the samples in the experiment.",
"help_text": "You will need to create a design file with information about the samples in your experiment before running the pipeline. Use this parameter to specify its location. It has to be a comma-separated file with 3 columns, and a header row.",
"fa_icon": "fas fa-file-csv"
},
"outdir": {
"type": "string",
"format": "directory-path",
"description": "The output directory where the results will be saved. You have to use absolute paths to storage on Cloud infrastructure.",
"fa_icon": "fas fa-folder-open"
},
"email": {
"type": "string",
"description": "Email address for completion summary.",
"fa_icon": "fas fa-envelope",
"help_text": "Set this parameter to your e-mail address to get a summary e-mail with details of the run sent to you when the workflow exits. If set in your user config file (`~/.nextflow/config`) then you don't need to specify this on the command line for every run.",
"pattern": "^([a-zA-Z0-9_\\-\\.]+)@([a-zA-Z0-9_\\-\\.]+)\\.([a-zA-Z]{2,5})$"
},
"multiqc_title": {
"type": "string",
"description": "MultiQC report title. Printed as page header, used for filename if not otherwise specified.",
"fa_icon": "fas fa-file-signature"
},
"cadd_prescored_indels": {
"type": "string",
"exists": true,
"format": "directory-path",
"fa_icon": "fas fa-file",
"description": "Path to a directory containing prescored indels for CADD.",
"help_text": "This folder contains the compressed files and indexes that would otherwise be in data/prescored folder as described in https://github.com/kircherlab/CADD-scripts/#manual-installation."
},
"cadd_resources": {
"type": "string",
"exists": true,
"format": "directory-path",
"fa_icon": "fas fa-file",
"description": "Path to a directory containing CADD annotations.",
"help_text": "This folder contains the uncompressed files that would otherwise be in data/annotation folder as described in https://github.com/kircherlab/CADD-scripts/#manual-installation."
},
"par_regions": {
"type": "string",
"description": "Provide a bed file of chrX and chrY PAR regions for DeepVariant",
"format": "file-path",
"exists": true
},
"tandem_repeats": {
"type": "string",
"format": "file-path",
"description": "A tandem repeat BED file for sniffles",
"pattern": "^\\S+\\.bed$",
"exists": true
},
"str_bed": {
"type": "string",
"description": "A BED file with repeats to be genotyped with TRGT",
"format": "file-path",
"exists": true
},
"echtvar_snv_databases": {
"type": "string",
"pattern": "^\\S+\\.(csv|tsv|json|ya?ml)$",
"format": "file-path",
"mimetype": "text/csv",
"schema": "/assets/schema_snp_db.json",
"description": "Path to a CSV/TSV/JSON/YAML file with echtvar databases to annotate SNVs with.",
"exists": true
},
"svdb_sv_databases": {
"type": "string",
"exists": true,
"format": "file-path",
"description": "Databases used for structural variant annotation in vcf format.",
"fa_icon": "fas fa-file-csv",
"help_text": "Path to a CSV/TSV/JSON/YAML file containing information about the databases used for structural variant annotation.",
"mimetype": "text/csv",
"pattern": "^\\S+\\.(csv|tsv|json|ya?ml)$",
"schema": "assets/svdb_query_vcf_schema.json"
},
"stranger_repeat_catalog": {
"type": "string",
"description": "A variant catalog json-file for stranger",
"format": "file-path",
"exists": true
},
"variant_consequences_snvs": {
"type": "string",
"description": "File containing list of SO terms listed in the order of severity from most severe to lease severe for annotating genomic SNVs. For more information check https://ensembl.org/info/genome/variation/prediction/predicted_data.html",
"fa_icon": "fas fa-file-csv"
},
"variant_consequences_svs": {
"type": "string",
"description": "File containing list of SO terms listed in the order of severity from most severe to lease severe for annotating genomic SVs. For more information check https://ensembl.org/info/genome/variation/prediction/predicted_data.html",
"fa_icon": "fas fa-file-csv"
},
"vep_cache": {
"type": "string",
"description": "A path to the VEP cache location",
"format": "path",
"exists": true
},
"target_regions": {
"type": "string",
"pattern": "^\\S+\\.bed$",
"format": "file-path",
"description": "A BED file with regions of interest.",
"exists": true
},
"methbat_regions": {
"type": "string",
"pattern": "^\\S+\\.tsv$",
"format": "file-path",
"description": "A tsv file with only regions of interest (example here: https://github.com/PacificBiosciences/MethBat/blob/main/data/cpgIslandExt.sorted.hg38.tsv) or with both regions and background cohort values (example here: https://github.com/PacificBiosciences/MethBat/blob/main/data/meth_profile_model.tsv), made with methbat build",
"exists": true
},
"modkit_call_regions": {
"type": "string",
"pattern": "^\\S+\\.bed$",
"format": "file-path",
"description": "A BED file with regions of interest for the methylation pileups. By default this is the same as `target_regions`.",
"exists": true
},
"mosdepth_regions": {
"type": "string",
"pattern": "^\\S+\\.bed$",
"format": "file-path",
"description": "A BED file with regions of interest used in mosdepth. By default this is the same as `qc_regions`.",
"exists": true
},
"mosdepth_d4_output": {
"type": "boolean",
"description": "Should mosdepth output d4-files.",
"fa_icon": "fas fa-users-cog",
"default": false
},
"bigwig_modcodes": {
"type": "string",
"pattern": "^[mhfcCgebTUaAoGnN](,[mhfcCgebTUaAoGnN])*$",
"description": "Comma-separated list of modification codes to include in the bigWig methylation visualization file. Defaults to 5hmC and 5mC. See https://samtools.github.io/hts-specs/SAMtags.pdf for a complete list.",
"default": "m"
},
"snv_call_regions": {
"type": "string",
"pattern": "^\\S+\\.bed$",
"format": "file-path",
"description": "A BED file containing regions to limit SNV calling. By default this is the same as `target_regions`.",
"exists": true
},
"sv_call_regions": {
"type": "string",
"pattern": "^\\S+\\.bed$",
"format": "file-path",
"description": "A BED file containging regions to filter SV calls. By default this is the same as `target_regions`.",
"exists": true
},
"qc_regions": {
"type": "string",
"pattern": "^\\S+\\.bed$",
"format": "file-path",
"description": "A BED file with regions of interest used in QC. By default this is the same as `target_regions`.",
"exists": true
},
"cnv_expected_xy_cn": {
"type": "string",
"format": "file-path",
"description": "A BED file containing expected copy number regions for XY samples.",
"exists": true
},
"cnv_expected_xx_cn": {
"type": "string",
"format": "file-path",
"description": "A BED file containing expected copy number regions for XX samples.",
"exists": true
},
"cnv_excluded_regions": {
"type": "string",
"format": "file-path",
"description": "A BED file specifying regions to exclude with HiFiCNV or Sawfish, such as centromeres.",
"exists": true
},
"genmod_reduced_penetrance": {
"type": "string",
"exists": true,
"format": "path",
"fa_icon": "fas fa-file-csv",
"description": "A file with gene ids that have reduced penetrance. For use with genmod."
},
"genmod_score_config_snvs": {
"type": "string",
"exists": true,
"format": "path",
"fa_icon": "fas fa-file",
"description": "A SNV rank model config file for genmod."
},
"genmod_score_config_svs": {
"type": "string",
"exists": true,
"format": "path",
"fa_icon": "fas fa-file",
"description": "A SV rank model config file for genmod."
},
"somalier_sites": {
"type": "string",
"pattern": "^\\S+\\.vcf(\\.gz)?$",
"description": "A VCF of known polymorphic sites for somalier",
"format": "file-path",
"exists": true
},
"gens_baf_positions": {
"type": "string",
"description": "Tab-delimited file with variant positions used to calculate B-allele frequencies for Gens inputs.",
"format": "file-path",
"exists": true
},
"gens_panel_of_normals_female": {
"type": "string",
"description": "Panel of normals of female samples (HDF5) used to standardize coverage for Gens inputs (https://gatk.broadinstitute.org/hc/en-us/articles/360040510031-CreateReadCountPanelOfNormals). This can be generated using https://github.com/nf-core/createpanelrefs. For long reads we have used mosdepth to calculate coverage per-bin rather than counting reads per bin, and then created a panel of normals using the GATK command.",
"format": "file-path",
"pattern": "^\\S+\\.(hd5|hdf5)$",
"exists": true
},
"gens_panel_of_normals_male": {
"type": "string",
"description": "Panel of normals of male samples (HDF5) used to standardize coverage for Gens inputs (https://gatk.broadinstitute.org/hc/en-us/articles/360040510031-CreateReadCountPanelOfNormals). This can be generated using https://github.com/nf-core/createpanelrefs. For long reads we have used mosdepth to calculate coverage per-bin rather than counting reads per bin, and then created a panel of normals using the GATK command.",
"format": "file-path",
"pattern": "^\\S+\\.(hd5|hdf5)$",
"exists": true
},
"gens_coverage_bins": {
"type": "string",
"description": "Bed file with bins for which to calculate coverage. Typically 100bp bins across the genome is used in Gens. It should be the same as the one used to prepare the panel of normals.",
"format": "file-path",
"pattern": "^\\S+\\.(bed)$",
"exists": true
},
"strdrop_training_set_json": {
"type": "string",
"pattern": "^\\S+\\.json$",
"description": "A JSON file containing the training set for strdrop",
"format": "file-path",
"exists": true
},
"paraphrase_output_format": {
"type": "string",
"enum": ["tsv", "json"],
"description": "Output format for paralog annotation from Paraphrase. Either `tsv` or `json`.",
"default": "tsv"
},
"paraphrase_rules": {
"type": "string",
"pattern": "^\\S+\\.(yml|yaml)$",
"format": "file-path",
"description": "A file path to a YAML file with rules for paraphrase to use when annotating paralogs. For an example, see: https://github.com/Clinical-Genomics/paraphrase/blob/main/test-data/rules.yaml.",
"exists": true
},
"peddy_sites": {
"type": "string",
"format": "file-path",
"description": "A file path to a VCF of known polymorphic sites for peddy. You may need to create a custom sites file if you have incomplete or targeted data.",
"exists": true
},
"sambamba_regions": {
"type": "string",
"pattern": "^\\S+\\.bed$",
"format": "file-path",
"description": "A BED file with regions of interest used in sambamba depth. By default this is the same as `qc_regions`.",
"exists": true
},
"alignment_output_format": {
"type": "string",
"fa_icon": "fa-solid fa-download",
"enum": ["bam", "cram"],
"description": "Output format for alignment files. Either `bam` or `cram`",
"default": "bam"
},
"create_maf_track": {
"type": "boolean",
"default": true,
"description": "Whether to create a MAF track from SNV calls when calling SVs with HiFiCNV or Sawfish. Requires SNV calling to finish before calling SVs, so deactivating this can speed up the pipeline. Defaults to `true`"
},
"create_hificnv_maf_track": {
"type": "boolean",
"default": true,
"description": "Whether to create a MAF track from SNV calls when calling CNVs with HiFiCNV. Requires SNV calling to finish before calling SVs, so deactivating this can speed up the pipeline. Defaults to `create_maf_track`",
"hidden": true
},
"create_sawfish_maf_track": {
"type": "boolean",
"default": true,
"description": "Whether to create a MAF track from SNV calls when calling SVs with Sawfish. Requires SNV calling to finish before calling SVs, so deactivating this can speed up the pipeline. Defaults to `create_maf_track`",
"hidden": true
},
"modules_testdata_base_path": {
"type": "string",
"fa_icon": "far fa-check-circle",
"description": "Base URL or local path to location of modules test dataset files",
"default": "https://raw.githubusercontent.com/nf-core/test-datasets/modules/data/",
"hidden": true
}
}
},
"reference_genome_options": {
"title": "Reference genome options",
"type": "object",
"fa_icon": "fas fa-dna",
"description": "Reference genome related files and options required for the workflow.",
"properties": {
"fasta": {
"type": "string",
"description": "Reference genome",
"pattern": "^.*\\.(fasta|fa|fna)(\\.gz)?$",
"format": "file-path",
"exists": true
}
}
},
"institutional_config_options": {
"title": "Institutional config options",
"type": "object",
"fa_icon": "fas fa-university",
"description": "Parameters used to describe centralised config profiles. These should not be edited.",
"help_text": "The centralised nf-core configuration profiles use a handful of pipeline parameters to describe themselves. This information is then printed to the Nextflow log when you run a pipeline. You should not need to change these values when you run a pipeline.",
"properties": {
"custom_config_version": {
"type": "string",
"description": "Git commit id for Institutional configs.",
"default": "master",
"hidden": true,
"fa_icon": "fas fa-users-cog"
},
"custom_config_base": {
"type": "string",
"description": "Base directory for Institutional configs.",
"default": "https://raw.githubusercontent.com/nf-core/configs/master",
"hidden": true,
"help_text": "If you're running offline, Nextflow will not be able to fetch the institutional config files from the internet. If you don't need them, then this is not a problem. If you do need them, you should download the files from the repo and tell Nextflow where to find them with this parameter.",
"fa_icon": "fas fa-users-cog"
},
"config_profile_name": {
"type": "string",
"description": "Institutional config name.",
"hidden": true,
"fa_icon": "fas fa-users-cog"
},
"config_profile_description": {
"type": "string",
"description": "Institutional config description.",
"hidden": true,
"fa_icon": "fas fa-users-cog"
},
"config_profile_contact": {
"type": "string",
"description": "Institutional config contact information.",
"hidden": true,
"fa_icon": "fas fa-users-cog"
},
"config_profile_url": {
"type": "string",
"description": "Institutional config URL link.",
"hidden": true,
"fa_icon": "fas fa-users-cog"
},
"publish_unannotated_family_svs": {
"type": "boolean",
"description": "Publish unannotated SVs and CNVs per family and caller.",
"hidden": true,
"fa_icon": "fas fa-users-cog"
}
}
},
"generic_options": {
"title": "Generic options",
"type": "object",
"fa_icon": "fas fa-file-import",
"description": "Less common options for the pipeline, typically set in a config file.",
"help_text": "These options are common to all nf-core pipelines and allow you to customise some of the core preferences for how the pipeline runs.\n\nTypically these options would be set in a Nextflow config file loaded for all pipeline runs, such as `~/.nextflow/config`.",
"properties": {
"version": {
"type": "boolean",
"description": "Display version and exit.",
"fa_icon": "fas fa-question-circle",
"hidden": true
},
"publish_dir_mode": {
"type": "string",
"default": "copy",
"description": "Method used to save pipeline results to output directory.",
"help_text": "The Nextflow `publishDir` option specifies which intermediate files should be saved to the output directory. This option tells the pipeline what method should be used to move these files. See [Nextflow docs](https://www.nextflow.io/docs/latest/process.html#publishdir) for details.",
"fa_icon": "fas fa-copy",
"enum": ["symlink", "rellink", "link", "copy", "copyNoFollow", "move"],
"hidden": true
},
"email_on_fail": {
"type": "string",
"description": "Email address for completion summary, only when pipeline fails.",
"fa_icon": "fas fa-exclamation-triangle",
"pattern": "^([a-zA-Z0-9_\\-\\.]+)@([a-zA-Z0-9_\\-\\.]+)\\.([a-zA-Z]{2,5})$",
"help_text": "An email address to send a summary email to when the pipeline is completed - ONLY sent if the pipeline does not exit successfully.",
"hidden": true
},
"plaintext_email": {
"type": "boolean",
"description": "Send plain-text email instead of HTML.",
"fa_icon": "fas fa-remove-format",
"hidden": true
},
"max_multiqc_email_size": {
"type": "string",
"description": "File size limit when attaching MultiQC reports to summary emails.",
"pattern": "^\\d+(\\.\\d+)?\\.?\\s*(K|M|G|T)?B$",
"default": "25.MB",
"fa_icon": "fas fa-file-upload",
"hidden": true
},
"monochrome_logs": {
"type": "boolean",
"description": "Do not use coloured log outputs.",
"fa_icon": "fas fa-palette",
"hidden": true
},
"hook_url": {
"type": "string",
"description": "Incoming hook URL for messaging service",
"fa_icon": "fas fa-people-group",
"help_text": "Incoming hook URL for messaging service. Currently, MS Teams and Slack are supported.",
"hidden": true
},
"multiqc_config": {
"type": "string",
"format": "file-path",
"description": "Custom config file to supply to MultiQC.",
"fa_icon": "fas fa-cog",
"hidden": true
},
"multiqc_logo": {
"type": "string",
"description": "Custom logo file to supply to MultiQC. File name must also be set in the MultiQC config file",
"fa_icon": "fas fa-image",
"hidden": true
},
"multiqc_methods_description": {
"type": "string",
"description": "Custom MultiQC yaml file containing HTML including a methods description.",
"fa_icon": "fas fa-cog"
},
"validate_params": {
"type": "boolean",
"description": "Boolean whether to validate parameters against the schema at runtime",
"default": true,
"fa_icon": "fas fa-check-square",
"hidden": true
},
"pipelines_testdata_base_path": {
"type": "string",
"fa_icon": "far fa-check-circle",
"description": "Base URL or local path to location of pipeline test dataset files",
"default": "https://raw.githubusercontent.com/genomic-medicine-sweden/test-datasets/eaabae15e3ee2b074057363a7467469b09f0957e/",
"hidden": true
},
"trace_report_suffix": {
"type": "string",
"fa_icon": "far calendar",
"description": "Suffix to add to the trace report filename. Default is the date and time in the format yyyy-MM-dd_HH-mm-ss.",
"hidden": true
},
"help": {
"type": ["boolean", "string"],
"description": "Display the help message."
},
"help_full": {
"type": "boolean",
"description": "Display the full detailed help message."
},
"show_hidden": {
"type": "boolean",
"description": "Display hidden parameters in the help message (only works when --help or --help_full are provided)."
}
}
},
"workflow_options": {
"title": "Workflow options",
"type": "object",
"description": "Workflow options specific to genomic-medicine-sweden/nallo",
"default": "",
"properties": {
"bcftools_roh_af_tag": {
"type": "string",
"description": "AF-tag that variants have been annotated with for use in the chromograph subworkflow. By default set to `--chromograph_af_tag`."
},
"chromograph_af_tag": {
"type": "string",
"description": "AF-tag to use in the chromograph subworkflow to generate plots of autozygosity. SNVs need to be annotated with allele frequencies specified by this tag for autozygosity plotting to work."
},
"preset": {
"type": "string",
"default": "revio",
"description": "Enable or disable certain parts of the pipeline by default, depending on data type (`revio`, `pacbio`, `ONT_R10`)",
"enum": ["revio", "pacbio", "ONT_R10"]
},
"sv_callers": {
"type": "string",
"description": "Which SV callers to use. Several callers can be specified, separated by commas (e.g. sniffles,severus,hificnv,sawfish). The order of the SV callers in this list will determine the priority of the calls when merging them if not overwritten by `sv_caller_priority`.",
"default": "sniffles,hificnv",
"pattern": "(?i)^(sniffles|hificnv|sawfish|severus)(,(sniffles|hificnv|sawfish|severus))*$"
},
"sv_callers_merge_priority": {
"type": "string",
"description": "The order of the SV callers in this list will determine the priority of the calls when merging them. All callers that has been specified in `sv_callers` should also be specified here separated by commas (e.g. sniffles,severus,hificnv,sawfish). By default same as `--sv_callers`.",
"default": "sniffles,hificnv",
"pattern": "(?i)^(sniffles|hificnv|sawfish|severus)(,(sniffles|hificnv|sawfish|severus))*$"
},
"sv_callers_to_run": {
"type": "string",
"description": "Which SV callers to run, separated by commas (e.g. sniffles,severus,hificnv,sawfish). By default same as `--sv_callers`",
"default": "sniffles,hificnv",
"pattern": "(?i)^(sniffles|hificnv|sawfish|severus)(,(sniffles|hificnv|sawfish|severus))*$"
},
"sv_callers_to_merge": {
"type": "string",
"description": "Which SV callers to merge into family VCFs (that are also used for annotation and ranking), separated by commas (e.g. sniffles,severus,hificnv,sawfish). By default same as `--sv_callers`",
"default": "sniffles,hificnv",
"pattern": "(?i)^(sniffles|hificnv|sawfish|severus)(,(sniffles|hificnv|sawfish|severus))*$"
},
"snv_caller": {
"type": "string",
"default": "deepvariant",
"description": "Which short variant software to use (`deepvariant`)",
"enum": ["deepvariant", "sentieon"]
},
"str_caller": {
"type": "string",
"default": "trgt",
"description": "Which caller to use for short tandem repeat expansions (TRGT or STRdust).",
"enum": ["trgt", "strdust"]
},
"paraphrase_genes": {
"type": "string",
"description": "An optional comma-separated list of genes to run Paraphrase on for paralog annotation. By default all genes called by paraphase are used."
},
"paraphrase_skip_keys": {
"type": "string",
"description": "An optional comma-separated list of keys to skip when running Paraphrase. By default the default skip keys are determined by Paraphrase."
},
"phaser": {
"type": "string",
"default": "longphase",
"description": "Which phasing software to use (`longphase`, `whatshap`, `hiphase`)",
"enum": ["longphase", "whatshap", "hiphase"]
},
"hifiasm_mode": {
"type": "string",
"description": "Run hifiasm in hifi-only or hifi-trio mode (`hifi-only`, `trio-binning`)",
"enum": ["hifi-only", "trio-binning"],
"default": "trio-binning"
},
"hifiasm_preset": {
"type": "string",
"description": "Hifiasm preset, is set to `--ont` when `--preset ONT_R10` is active.",
"enum": ["", "--ont"],
"default": null
},
"run_methbat": {
"type": "boolean",
"description": "Run methbat for methylation analysis, set to `true` by default when `--preset revio` is active."
},
"run_modkit": {
"type": "boolean",
"description": "Run modkit for methylation analysis, set to `true` by default when `--preset ONT_R10` is active."
},
"methbat_male_label": {
"type": "string",
"description": "Label used for male samples in methbat profile.",
"default": "MALE"
},
"methbat_female_label": {
"type": "string",
"description": "Label used for female samples in methbat profile.",
"default": "FEMALE"
},
"modkit_modified_bases": {
"type": "string",
"description": "Modkit modified bases, separated by space. E.g. '5mC 5hmC'",
"default": "5mC"
},
"alignment_processes": {
"type": "integer",
"minimum": 1,
"default": 8,
"description": "If alignment_processes is bigger than 1, input files will be split and aligned in parallel to reduce processing time."
},
"snv_calling_processes": {
"type": "integer",
"default": 13,
"description": "If snv_calling_processes is bigger than 1, short variant calling will be done in parallel to reduce processing time.",
"minimum": 1
},
"vep_cache_version": {
"type": "integer",
"default": 110,
"description": "VEP cache version"
},
"vep_plugin_files": {
"type": "string",
"mimetype": "text/csv",
"pattern": "^\\S+\\.(csv|tsv|json|ya?ml)$",
"description": "Path to a CSV/TSV/JSON/YAML file with vep_files as header, and then paths to vep plugin files. Paths to pLI_values.txt and LoFtool_scores.txt are required.",
"schema": "assets/vep_plugin_files_schema.json"
},
"force_sawfish_joint_call_single_samples": {
"type": "boolean",
"description": "Force sawfish to run joint-call on single samples instead of all samples from the same family. This effectively causes SVDB to merge the samples into family VCFs instead."
},
"filter_variants_hgnc_ids": {
"type": "string",
"pattern": "^\\S+\\.(csv|tsv)$",
"description": "A tsv/csv file with a `hgnc_ids` column header, and then one numerical HGNC ID per row. E.g. `4281` or `HGNC:4281`.",
"format": "file-path",
"exits": true,
"schema": "assets/schema_hgnc_ids.json"
},
"filter_snvs_expression": {
"type": "string",
"default": null,
"description": "An expression that is passed to bcftools view to filter SNVs, e.g. --filter_snvs_expression \"-e 'INFO/AQ>60'\""
},
"filter_svs_expression": {
"type": "string",
"default": null,
"description": "An expression that is passed to bcftools view to filter SVs, e.g. --filter_svs_expression \"-e 'INFO/AQ>60'\""
},
"deepvariant_model_type": {
"type": "string",
"default": "PACBIO",
"description": "Sets the model type used for DeepVariant. This is set automatically using `--preset` by default.",
"hidden": true,
"enum": ["PACBIO", "ONT_R104"]
},
"minimap2_read_mapping_preset": {
"type": "string",
"description": "Sets the minimap2-preset (-x) for read alignment. This is set automatically using the pipeline `--preset` by default.",
"hidden": true,
"enum": ["map-hifi", "map-ont", "lr:hq", "lr:hqae"],
"default": "map-hifi"
},
"extra_hifiasm_options": {
"type": "string",
"hidden": true,
"description": "Extra options to hifiasm, used for test profile."
},
"extra_methbat_profile_options": {
"type": "string",
"hidden": true,
"description": "Extra options to methbat profile."
},
"extra_modkit_options": {
"type": "string",
"hidden": true,
"description": "Extra options to modkit, used for test profile."
},
"extra_paraphase_options": {
"type": "string",
"hidden": true,
"description": "Extra options to Paraphase, used for test profile."
},
"extra_sawfish_options": {
"type": "string",
"hidden": true,
"description": "Extra options to Sawfish, used for test profile."
},
"extra_vep_options": {
"type": "string",
"hidden": true,
"description": "Extra options to VEP, used for test profile."
},
"extra_yak_options": {
"type": "string",
"hidden": true,
"description": "Extra options to yak, used for test profile."
},
"genmod_compound_snv_penalty": {
"type": "integer",
"default": 6,
"description": "Genmod compound penalty for SNVs."
},
"genmod_compound_snv_threshold": {
"type": "integer",
"default": 9,
"description": "Genmod compound threshold for SNVs."
},
"genmod_compound_sv_penalty": {
"type": "integer",
"default": 6,
"description": "Genmod compound penalty for SVs."
},
"genmod_compound_sv_threshold": {
"type": "integer",
"default": 9,
"description": "Genmod compound threshold for SVs."
},
"genmod_compound_singleton_snv_penalty": {
"type": "integer",
"description": "Genmod compound penalty for SNVs. Applied in families with an affected individual without two parents. By default same as `--genmod_compound_snv_penalty`."
},
"genmod_compound_singleton_snv_threshold": {
"type": "integer",
"description": "Genmod compound threshold for SNVs. Applied in families with an affected individual without two parents. By default same as `--genmod_compound_snv_threshold`."
},
"genmod_compound_singleton_sv_penalty": {
"type": "integer",
"description": "Genmod compound penalty for SVs. Applied in families with an affected individual without two parents. By default same as `--genmod_compound_sv_penalty`."
},
"genmod_compound_singleton_sv_threshold": {
"type": "integer",
"description": "Genmod compound threshold for SVs. Applied in families with an affected individual without two parents. By default same as `--genmod_compound_sv_threshold`."
},
"genmod_compound_trio_snv_penalty": {
"type": "integer",
"description": "Genmod compound penalty for SNVs. Applied in families with at least one affected individual with two parents. By default same as `--genmod_compound_snv_penalty`."
},
"genmod_compound_trio_snv_threshold": {
"type": "integer",
"description": "Genmod compound threshold for SNVs. Applied in families with at least one affected individual with two parents. By default same as `--genmod_compound_snv_threshold`."
},
"genmod_compound_trio_sv_penalty": {
"type": "integer",
"description": "Genmod compound penalty for SVs. Applied in families with at least one affected individual with two parents. By default same as `--genmod_compound_sv_penalty`."
},
"genmod_compound_trio_sv_threshold": {
"type": "integer",
"description": "Genmod compound threshold for SVs. Applied in families with at least one affected individual with two parents. By default same as `--genmod_compound_sv_threshold`."
},
"plot_chromograph_autozygosity": {
"type": "boolean",
"description": "Whether to plot chromograph autozygosity plots in the chromograph subworkflow. This requires SNVs to be annotated with allele frequencies, and is therefore false by default unless `--bcftools_roh_af_tag` and `--rhocallviz_af_tag` have been set, in which case it is assumed that the user has annotated the SNVs with the correct tag."
},
"plot_chromograph_coverage": {
"type": "boolean",
"default": true,
"description": "Whether to plot chromograph coverage plots in the chromograph subworkflow."
},
"pre_vep_snv_filter_expression": {
"type": "string",
"default": null,
"description": "An expression that is passed to bcftools view to filter SNVs before being annotated with VEP, e.g. --pre_vep_snv_filter_expression \"-e 'INFO/AQ>60'\". The expression applies to both the clinical and the research VCFs."
},
"rhocallviz_af_tag": {
"type": "string",
"description": "AF-tag that variants have been annotated with, for use in the chromograph subworkflow. By default set to `--chromograph_af_tag."
},
"rhocallviz_min_af": {
"type": "number",
"default": 0.0001,
"description": "Minimum allele frequency for variants to be included in rhocall viz within the chromograph subworkflow."
},
"rhocallviz_min_qual": {
"type": "number",
"default": 10.0,
"description": "Minimum quality for variants to be included in rhocall viz within the chromograph subworkflow."
},
"tiddit_bin_size": {
"type": "integer",
"default": 500,
"description": "Bin size to use for TIDDIT coverage wig generation in the chromograph subworkflow."
},
"sentieon_model_bundle": {
"type": "string",
"format": "file-path",
"exists": true,
"description": "The location of the DNAscope model bundle. Model bundle files can be found in the sentieon-models Github repository."
},
"sentieon_tech": {
"type": "string",
"default": "HiFi",
"enum": ["HiFi", "ONT"],
"description": "Sequencing technology used to generate the reads. Supported arguments are ONT or HiFi."
},
"sentieon_male_haploid_bed": {
"type": "string",
"format": "file-path",
"pattern": "^\\S+\\.bed$",
"exists": true,
"description": "Interval in the reference to restrict haploid variant calling for males, in BED file format."
},
"sentieon_male_diploid_bed": {
"type": "string",
"format": "file-path",
"pattern": "^\\S+\\.bed$",
"exists": true,
"description": "Interval in the reference to restrict diploid variant calling for males, in BED file format."
},
"sentieon_female_diploid_bed": {
"type": "string",
"format": "file-path",
"pattern": "^\\S+\\.bed$",
"exists": true,
"description": "Interval in the reference to restrict diploid variant calling for females, in BED file format."
},
"strdrop_fraction": {
"type": "number",
"default": 0.66,
"description": "Case average adjusted sequencing depth ratio cutoff in strdrop."
},
"strdrop_alpha": {
"type": "number",
"default": 0.18,
"description": "Unadjusted probability confidence level for coverage test in strdrop."
},
"strdrop_edit": {
"type": "number",
"default": 0.9,
"description": "Allele similarity Levenshtein edit distance ratio cutoff in strdrop."
}
},
"required": ["preset"]
}
},
"allOf": [
{
"$ref": "#/$defs/workflow_skip_options"
},
{
"$ref": "#/$defs/input_output_options"
},
{
"$ref": "#/$defs/reference_genome_options"
},
{
"$ref": "#/$defs/institutional_config_options"
},
{
"$ref": "#/$defs/generic_options"
},
{
"$ref": "#/$defs/workflow_options"
}
]
}