-
Notifications
You must be signed in to change notification settings - Fork 100
/
nextflow_schema.json
949 lines (949 loc) · 55.4 KB
/
nextflow_schema.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
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
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://raw.githubusercontent.com/nf-core/mag/master/nextflow_schema.json",
"title": "nf-core/mag pipeline parameters",
"description": "Assembly, binning and annotation of metagenomes",
"type": "object",
"definitions": {
"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",
"mimetype": "text/csv",
"format": "file-path-pattern",
"exists": true,
"schema": "assets/schema_input.json",
"pattern": "^\\S+\\.csv$",
"description": "CSV samplesheet file containing information about the samples in the experiment.",
"help_text": "Use this to specify the location of your input FastQ files and their associated metadata. You can also use the CSV file to assign different groups or to include long reads for hybrid assembly with metaSPAdes. The CSV file must have at least two columns (sample, short_reads1) and with a maximum CSV sheet having the headers: sample,run,group,short_reads_1,short_reads_2,long_reads. See [usage docs](https://nf-co.re/mag/usage#input-specifications).",
"fa_icon": "fas fa-file-csv"
},
"single_end": {
"type": "boolean",
"description": "Specifies that the input is single-end reads.",
"fa_icon": "fas fa-align-center",
"help_text": "By default, the pipeline expects paired-end data. If you have single-end data, you need to specify `--single_end` on the command line when you launch the pipeline. A normal glob pattern, enclosed in quotation marks, can then be used for `--input`. For example:\n\n```bash\n--single_end --input '*.fastq'\n```\n\nIt is not possible to run a mixture of single-end and paired-end files in one run."
},
"assembly_input": {
"type": "string",
"mimetype": "text/csv",
"format": "file-path-pattern",
"exists": true,
"schema": "assets/schema_assembly_input.json",
"pattern": "^\\S+\\.csv$",
"description": "Additional input CSV samplesheet containing information about pre-computed assemblies. When set, both read pre-processing and assembly are skipped and the pipeline begins at the binning stage.",
"help_text": "If you have pre-computed assemblies from another source, it is possible to jump straight to the binning stage of the pipeline by supplying these assemblies in a CSV file. This CSV file should have at minimum three columns and the following header: `id,group,assembler,fasta` (group is only required when `--coassemble_group). Short reads must still be supplied in to `--input` in CSV format. See [usage docs](https://nf-co.re/mag/usage#input-specifications) for further details.",
"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"
}
}
},
"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": {
"igenomes_base": {
"type": "string",
"format": "directory-path",
"description": "Directory / URL base for iGenomes references.",
"default": "s3://ngi-igenomes/igenomes/",
"fa_icon": "fas fa-cloud-download-alt",
"hidden": true
},
"igenomes_ignore": {
"type": "boolean",
"description": "Do not load the iGenomes reference config.",
"fa_icon": "fas fa-ban",
"hidden": true,
"help_text": "Do not load `igenomes.config` when running the pipeline. You may choose this option if you observe clashes between custom parameters and those supplied in `igenomes.config`."
}
}
},
"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"
}
}
},
"max_job_request_options": {
"title": "Max job request options",
"type": "object",
"fa_icon": "fab fa-acquisitions-incorporated",
"description": "Set the top limit for requested resources for any single job.",
"help_text": "If you are running on a smaller system, a pipeline step requesting more resources than are available may cause the Nextflow to stop the run with an error. These options allow you to cap the maximum resources requested by any single job so that the pipeline will run on your system.\n\nNote that you can not _increase_ the resources requested by any job using these options. For that you will need your own configuration file. See [the nf-core website](https://nf-co.re/usage/configuration) for details.",
"properties": {
"max_cpus": {
"type": "integer",
"description": "Maximum number of CPUs that can be requested for any single job.",
"default": 16,
"fa_icon": "fas fa-microchip",
"hidden": true,
"help_text": "Use to set an upper-limit for the CPU requirement for each process. Should be an integer e.g. `--max_cpus 1`"
},
"max_memory": {
"type": "string",
"description": "Maximum amount of memory that can be requested for any single job.",
"default": "128.GB",
"fa_icon": "fas fa-memory",
"pattern": "^\\d+(\\.\\d+)?\\.?\\s*(K|M|G|T)?B$",
"hidden": true,
"help_text": "Use to set an upper-limit for the memory requirement for each process. Should be a string in the format integer-unit e.g. `--max_memory '8.GB'`"
},
"max_time": {
"type": "string",
"description": "Maximum amount of time that can be requested for any single job.",
"default": "240.h",
"fa_icon": "far fa-clock",
"pattern": "^(\\d+\\.?\\s*(s|m|h|d|day)\\s*)+$",
"hidden": true,
"help_text": "Use to set an upper-limit for the time requirement for each process. Should be a string in the format integer-unit e.g. `--max_time '2.h'`"
}
}
},
"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": {
"help": {
"type": "boolean",
"description": "Display help text.",
"fa_icon": "fas fa-question-circle",
"hidden": true
},
"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
},
"validationShowHiddenParams": {
"type": "boolean",
"fa_icon": "far fa-eye-slash",
"description": "Show all params when using `--help`",
"hidden": true,
"help_text": "By default, parameters set as _hidden_ in the schema are not shown on the command line when a user runs with `--help`. Specifying this option will tell the pipeline to show all parameters."
},
"validationFailUnrecognisedParams": {
"type": "boolean",
"fa_icon": "far fa-check-circle",
"description": "Validation of parameters fails when an unrecognised parameter is found.",
"hidden": true,
"help_text": "By default, when an unrecognised parameter is found, it returns a warinig."
},
"validationLenientMode": {
"type": "boolean",
"fa_icon": "far fa-check-circle",
"description": "Validation of parameters in lenient more.",
"hidden": true,
"help_text": "Allows string values that are parseable as numbers or booleans. For further information see [JSONSchema docs](https://github.com/everit-org/json-schema#lenient-mode)."
},
"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/nf-core/test-datasets/",
"hidden": true
}
}
},
"reproducibility_options": {
"title": "Reproducibility options",
"type": "object",
"description": "Use these parameters to also enable reproducible results from the individual assembly and binning tools .",
"default": "",
"properties": {
"megahit_fix_cpu_1": {
"type": "boolean",
"description": "Fix number of CPUs for MEGAHIT to 1. Not increased with retries.",
"help_text": "MEGAHIT only generates reproducible results when run single-threaded. \n\nWhen using this parameter do not change the number of CPUs for the `megahit` process with a custom config file. This would result in an error.\n\nDefault: The number of CPUs is specified in the `base.config` file, and increased with each retry."
},
"spades_fix_cpus": {
"type": "integer",
"default": -1,
"description": "Fix number of CPUs used by SPAdes. Not increased with retries.",
"help_text": "SPAdes is designed to be deterministic for a given number of threads. To generate reproducible results fix the number of CPUs using this parameter.\n\nWhen using this parameter do not change the number of CPUs for the `spades` process with a custom config file. This would result in an error.\n\nDefault: -1 (the number of CPUs is specified in the `base.config` or in a custom config file, and increased with each retry)."
},
"spadeshybrid_fix_cpus": {
"type": "integer",
"default": -1,
"description": "Fix number of CPUs used by SPAdes hybrid. Not increased with retries.",
"help_text": "SPAdes is designed to be deterministic for a given number of threads. To generate reproducible results fix the number of CPUs using this parameter.\n\nWhen using this parameter do not change the number of CPUs for the `spadeshybrid` process with a custom config file. This would result in an error.\n\nDefault: -1 (the number of CPUs is specified in the `base.config` or in a custom config file, and increased with each retry)."
},
"metabat_rng_seed": {
"type": "integer",
"default": 1,
"description": "RNG seed for MetaBAT2.",
"help_text": "MetaBAT2 is run by default with a fixed seed within this pipeline, thus producing reproducible results. You can set it also to any other positive integer to ensure reproducibility. Set the parameter to 0 to use a random seed."
}
},
"help_text": ""
},
"quality_control_for_short_reads_options": {
"title": "Quality control for short reads options",
"type": "object",
"description": "",
"default": "",
"properties": {
"clip_tool": {
"type": "string",
"default": "fastp",
"description": "Specify which adapter clipping tool to use.",
"enum": ["fastp", "adapterremoval"]
},
"save_clipped_reads": {
"type": "boolean",
"description": "Specify to save the resulting clipped FASTQ files to --outdir."
},
"reads_minlength": {
"type": "integer",
"default": 15,
"description": "The minimum length of reads must have to be retained for downstream analysis."
},
"fastp_qualified_quality": {
"type": "integer",
"default": 15,
"description": "Minimum phred quality value of a base to be qualified in fastp.",
"help": "Reads with more than 40% of unqualified bases will be discarded."
},
"fastp_cut_mean_quality": {
"type": "integer",
"default": 15,
"description": "The mean quality requirement used for per read sliding window cutting by fastp.",
"help": "Used in combination with the fastp options '--cut_front' and '--cut_tail'. If the mean quality within a window (of size 4) is below `--fastp_cut_mean_quality`, the bases are dropped and the sliding window is moved further, otherwise it stops."
},
"fastp_save_trimmed_fail": {
"type": "boolean",
"description": "Save reads that fail fastp filtering in a separate file. Not used downstream."
},
"adapterremoval_minquality": {
"type": "integer",
"default": 2,
"description": "The minimum base quality for low-quality base trimming by AdapterRemoval."
},
"adapterremoval_trim_quality_stretch": {
"type": "boolean",
"description": "Turn on quality trimming by consecutive stretch of low quality bases, rather than by window.",
"help_text": "Default base-quality trimming is set to trim by 'windows', as in FastP. Specifying this flag will use trim via contiguous stretch of low quality bases (Ns) instead.\n\n> Replaces --trimwindows 4 with --trimqualities in AdapterRemoval"
},
"adapterremoval_adapter1": {
"type": "string",
"default": "AGATCGGAAGAGCACACGTCTGAACTCCAGTCACNNNNNNATCTCGTATGCCGTCTTCTGCTTG",
"description": "Forward read adapter to be trimmed by AdapterRemoval."
},
"adapterremoval_adapter2": {
"type": "string",
"default": "AGATCGGAAGAGCGTCGTGTAGGGAAAGAGTGTAGATCTCGGTGGTCGCCGTATCATT",
"description": "Reverse read adapter to be trimmed by AdapterRemoval for paired end data."
},
"host_genome": {
"type": "string",
"help_text": "This parameter is mutually exclusive with `--host_fasta`. Host read removal is done with Bowtie2. \nBoth the iGenomes FASTA file as well as corresponding, already pre-built Bowtie 2 index files will be used.",
"description": "Name of iGenomes reference for host contamination removal."
},
"host_fasta": {
"type": "string",
"description": "Fasta reference file for host contamination removal.",
"help_text": "This parameter is mutually exclusive with `--host_genome`. The reference can be masked. Host read removal is done with Bowtie2."
},
"host_removal_verysensitive": {
"type": "boolean",
"description": "Use the `--very-sensitive` instead of the`--sensitive`setting for Bowtie 2 to map reads against the host genome."
},
"host_removal_save_ids": {
"type": "boolean",
"description": "Save the read IDs of removed host reads."
},
"save_hostremoved_reads": {
"type": "boolean",
"description": "Specify to save input FASTQ files with host reads removed to --outdir."
},
"keep_phix": {
"type": "boolean",
"description": "Keep reads similar to the Illumina internal standard PhiX genome."
},
"phix_reference": {
"type": "string",
"default": "${baseDir}/assets/data/GCA_002596845.1_ASM259684v1_genomic.fna.gz",
"description": "Genome reference used to remove Illumina PhiX contaminant reads.",
"hidden": true
},
"skip_clipping": {
"type": "boolean",
"description": "Skip read preprocessing using fastp or adapterremoval."
},
"save_phixremoved_reads": {
"type": "boolean",
"description": "Specify to save input FASTQ files with phiX reads removed to --outdir."
},
"bbnorm": {
"type": "boolean",
"description": "Run BBnorm to normalize sequence depth."
},
"bbnorm_target": {
"type": "integer",
"default": 100,
"description": "Set BBnorm target maximum depth to this number."
},
"bbnorm_min": {
"type": "integer",
"default": 5,
"description": "Set BBnorm minimum depth to this number."
},
"save_bbnorm_reads": {
"type": "boolean",
"description": "Save normalized read files to output directory."
}
}
},
"quality_control_for_long_reads_options": {
"title": "Quality control for long reads options",
"type": "object",
"description": "",
"default": "",
"properties": {
"skip_adapter_trimming": {
"type": "boolean",
"description": "Skip removing adapter sequences from long reads."
},
"longreads_min_length": {
"type": "integer",
"default": 1000,
"description": "Discard any read which is shorter than this value."
},
"longreads_keep_percent": {
"type": "integer",
"default": 90,
"description": "Keep this percent of bases."
},
"longreads_length_weight": {
"type": "integer",
"default": 10,
"description": "The higher the more important is read length when choosing the best reads.",
"help_text": "The default value focuses on length instead of quality to improve assembly size.\nIn order to assign equal weights to read lengths and read qualities set this parameter to 1.\nThis might be useful, for example, to benefit indirectly from the removal of short host reads (causing lower qualities for reads not overlapping filtered short reads)."
},
"keep_lambda": {
"type": "boolean",
"description": "Keep reads similar to the ONT internal standard Escherichia virus Lambda genome."
},
"lambda_reference": {
"type": "string",
"default": "${baseDir}/assets/data/GCA_000840245.1_ViralProj14204_genomic.fna.gz",
"hidden": true,
"description": "Genome reference used to remove ONT Lambda contaminant reads."
},
"save_lambdaremoved_reads": {
"type": "boolean",
"description": "Specify to save input FASTQ files with lamba reads removed to --outdir."
},
"save_porechop_reads": {
"type": "boolean",
"description": "Specify to save the resulting clipped FASTQ files to --outdir."
},
"save_filtlong_reads": {
"type": "boolean",
"description": "Specify to save the resulting length filtered FASTQ files to --outdir."
}
}
},
"taxonomic_profiling_options": {
"title": "Taxonomic profiling options",
"type": "object",
"description": "Taxonomic classification is disabled by default. You have to specify one of the options below to activate it.",
"default": "",
"properties": {
"centrifuge_db": {
"type": "string",
"description": "Database for taxonomic binning with centrifuge.",
"help_text": "Local directory containing `*.cf` files, or a URL or local path to a downloaded compressed tar archive of a Centrifuge database. E.g. ftp://ftp.ccb.jhu.edu/pub/infphilo/centrifuge/data/p_compressed+h+v.tar.gz."
},
"kraken2_db": {
"type": "string",
"description": "Database for taxonomic binning with kraken2.",
"help_text": "Path to a local directory, archive file, or a URL to compressed tar archive that contains at least the three files `hash.k2d`, `opts.k2d` and `taxo.k2d`. E.g. ftp://ftp.ccb.jhu.edu/pub/data/kraken2_dbs/minikraken_8GB_202003.tgz."
},
"krona_db": {
"type": "string",
"description": "Database for taxonomic binning with krona",
"help_text": "Path to `taxonomy.tab` file for Krona, instead of downloading the default file. Point at the `.tab` file."
},
"skip_krona": {
"type": "boolean",
"description": "Skip creating a krona plot for taxonomic binning."
},
"cat_db": {
"type": "string",
"description": "Database for taxonomic classification of metagenome assembled genomes. Can be either a zipped file or a directory containing the extracted output of such.",
"help_text": "E.g. https://tbb.bio.uu.nl/bastiaan/CAT_prepare/CAT_prepare_20210107.tar.gz. This parameter is mutually exclusive with `--cat_db_generate`. The file needs to contain a folder named `*taxonomy*` and `*database*` that hold the respective files."
},
"cat_db_generate": {
"type": "boolean",
"description": "Generate CAT database.",
"help_text": "Download the taxonomy files from NCBI taxonomy, the nr database and generate CAT database. This parameter is mutually exclusive with `--cat_db`. Useful to build a CAT database with the same DIAMOND version as used for running CAT classification, avoiding compatibility problems."
},
"save_cat_db": {
"type": "boolean",
"description": "Save the CAT database generated when specified by `--cat_db_generate`.",
"help_text": "Useful to allow reproducibility, as old versions of prebuild CAT databases do not always remain accessible and underlying NCBI taxonomy and nr databases change."
},
"cat_official_taxonomy": {
"type": "boolean",
"description": "Only return official taxonomic ranks (Kingdom, Phylum, etc.) when running CAT."
},
"skip_gtdbtk": {
"type": "boolean",
"description": "Skip the running of GTDB, as well as the automatic download of the database"
},
"gtdb_db": {
"type": "string",
"description": "Specify the location of a GTDBTK database. Can be either an uncompressed directory or a `.tar.gz` archive. If not specified will be downloaded for you when GTDBTK or binning QC is not skipped.",
"default": "https://data.ace.uq.edu.au/public/gtdb/data/releases/release214/214.1/auxillary_files/gtdbtk_r214_data.tar.gz"
},
"gtdb_mash": {
"type": "string",
"description": "Specify the location of a GTDBTK mash database. If missing, GTDB-Tk will skip the ani_screening step"
},
"gtdbtk_min_completeness": {
"type": "number",
"default": 50,
"description": "Min. bin completeness (in %) required to apply GTDB-tk classification.",
"help_text": "Completeness assessed with BUSCO analysis (100% - %Missing). Must be greater than 0 (min. 0.01) to avoid GTDB-tk errors. If too low, GTDB-tk classification results can be impaired due to not enough marker genes!",
"minimum": 0.01,
"maximum": 100
},
"gtdbtk_max_contamination": {
"type": "number",
"default": 10,
"description": "Max. bin contamination (in %) allowed to apply GTDB-tk classification.",
"help_text": "Contamination approximated based on BUSCO analysis (%Complete and duplicated). If too high, GTDB-tk classification results can be impaired due to contamination!",
"minimum": 0,
"maximum": 100
},
"gtdbtk_min_perc_aa": {
"type": "number",
"default": 10,
"description": "Min. fraction of AA (in %) in the MSA for bins to be kept.",
"minimum": 0,
"maximum": 100
},
"gtdbtk_min_af": {
"type": "number",
"default": 0.65,
"description": "Min. alignment fraction to consider closest genome.",
"minimum": 0,
"maximum": 1
},
"gtdbtk_pplacer_cpus": {
"type": "number",
"default": 1,
"description": "Number of CPUs used for the by GTDB-Tk run tool pplacer.",
"help_text": "A low number of CPUs helps to reduce the memory required/reported by GTDB-Tk. See also the [GTDB-Tk documentation](https://ecogenomics.github.io/GTDBTk/faq.html#gtdb-tk-reaches-the-memory-limit-pplacer-crashes)."
},
"gtdbtk_pplacer_scratch": {
"type": "boolean",
"default": true,
"description": "Reduce GTDB-Tk memory consumption by running pplacer in a setting writing to disk.",
"help_text": "Will be slower. Set to `false` to turn this off."
},
"genomad_db": {
"type": "string",
"description": "Database for virus classification with geNomad",
"help_text": "Must be a directory containing the uncompressed contents from https://portal.nersc.gov/genomad/__data__/genomad_db_v1.1.tar.gz"
}
}
},
"assembly_options": {
"title": "Assembly options",
"type": "object",
"description": "",
"default": "",
"properties": {
"coassemble_group": {
"type": "boolean",
"description": "Co-assemble samples within one group, instead of assembling each sample separately."
},
"spades_options": {
"type": "string",
"description": "Additional custom options for SPAdes.",
"help_text": "An example is adjusting k-mers (\"-k 21,33,55,77\") or adding [advanced options](https://github.com/ablab/spades#advanced-options). But not -t, -m, -o or --out-prefix, because these are already in use. Must be used like this: --spades_options=\"-k 21,33,55,77\")"
},
"megahit_options": {
"type": "string",
"description": "Additional custom options for MEGAHIT.",
"help_text": "An example is adjusting presets (e.g. \"--presets meta-large\"), k-mers (e.g. \"-k 21,33,55,77\") or adding other [advanced options](https://github.com/voutcn/megahit#advanced-usage). For example, increase the minimum k-mer in the event of an error message such as \"Too many vertices in the unitig graph, you may increase the kmer size to remove tons of erroneous kmers.\" in the MEGAHIT log file. But not --threads, --memory, -o or input read files, because these are already in use. Must be used like this: --megahit_options=\"--presets meta-large\""
},
"skip_spades": {
"type": "boolean",
"description": "Skip Illumina-only SPAdes assembly."
},
"skip_spadeshybrid": {
"type": "boolean",
"description": "Skip SPAdes hybrid assembly."
},
"skip_megahit": {
"type": "boolean",
"description": "Skip MEGAHIT assembly."
},
"skip_quast": {
"type": "boolean",
"description": "Skip metaQUAST."
}
}
},
"gene_prediction_and_annotation_options": {
"title": "Gene prediction and annotation options",
"type": "object",
"description": "",
"default": "",
"properties": {
"skip_prodigal": {
"type": "boolean",
"description": "Skip Prodigal gene prediction"
},
"skip_prokka": {
"type": "boolean",
"description": "Skip Prokka genome annotation."
},
"skip_metaeuk": {
"type": "boolean",
"description": "Skip MetaEuk gene prediction and annotation"
},
"metaeuk_mmseqs_db": {
"type": "string",
"description": "A string containing the name of one of the databases listed in the [mmseqs2 documentation](https://github.com/soedinglab/MMseqs2/wiki#downloading-databases). This database will be downloaded and formatted for eukaryotic genome annotation. Incompatible with --metaeuk_db.",
"help_text": "mmseqs2 lists a large number of databases, not all of which are appropriate for use with MetaEuk. MetaEuk requires protein inputs, so you should select one of the Aminoacid or Profile options."
},
"metaeuk_db": {
"type": "string",
"description": "Path to either a local fasta file of protein sequences, or to a directory containing an mmseqs2-formatted database, for annotation of eukaryotic genomes.",
"help_text": "One option would be the databases from the MetaEuk publication (https://wwwuser.gwdg.de/~compbiol/metaeuk/), however it should be noted that these are focused on marine eukaryotes."
},
"save_mmseqs_db": {
"type": "boolean",
"description": "Save the downloaded mmseqs2 database specified in `--metaeuk_mmseqs_db`."
}
}
},
"virus_identification_options": {
"title": "Virus identification options",
"type": "object",
"default": "",
"properties": {
"run_virus_identification": {
"type": "boolean",
"description": "Run virus identification."
},
"genomad_min_score": {
"type": "number",
"default": 0.7,
"description": "Minimum geNomad score for a sequence to be considered viral"
},
"genomad_splits": {
"type": "integer",
"default": 1,
"description": "Number of groups that geNomad's MMSeqs2 databse should be split into (reduced memory requirements)"
}
}
},
"binning_options": {
"title": "Binning options",
"type": "object",
"description": "",
"default": "",
"properties": {
"binning_map_mode": {
"type": "string",
"default": "group",
"description": "Defines mapping strategy to compute co-abundances for binning, i.e. which samples will be mapped against the assembly.",
"help_text": "Available: `all`, `group` or `own`. Note that `own` cannot be specified in combination with `--coassemble_group`.\n\nNote that specifying `all` without additionally specifying `--coassemble_group` results in `n^2` mapping processes for each assembly method, where `n` is the number of samples.",
"enum": ["all", "group", "own"]
},
"skip_binning": {
"type": "boolean",
"description": "Skip metagenome binning entirely"
},
"skip_metabat2": {
"type": "boolean",
"description": "Skip MetaBAT2 Binning"
},
"skip_maxbin2": {
"type": "boolean",
"description": "Skip MaxBin2 Binning"
},
"skip_concoct": {
"type": "boolean",
"description": "Skip CONCOCT Binning"
},
"min_contig_size": {
"type": "integer",
"default": 1500,
"description": "Minimum contig size to be considered for binning and for bin quality check.",
"help_text": "For forwarding into downstream analysis, i.e. QUAST and BUSCO, and reporting."
},
"min_length_unbinned_contigs": {
"type": "integer",
"default": 1000000,
"description": "Minimal length of contigs that are not part of any bin but treated as individual genome.",
"help_text": "Contigs that do not fulfill the thresholds of `--min_length_unbinned_contigs` and `--max_unbinned_contigs` are pooled for downstream analysis and reporting, except contigs that also do not fullfill `--min_contig_size` are not considered further."
},
"max_unbinned_contigs": {
"type": "integer",
"default": 100,
"description": "Maximal number of contigs that are not part of any bin but treated as individual genome.",
"help_text": "Contigs that do not fulfill the thresholds of `--min_length_unbinned_contigs` and `--max_unbinned_contigs` are pooled for downstream analysis and reporting, except contigs that also do not fullfill `--min_contig_size` are not considered further."
},
"bowtie2_mode": {
"type": "string",
"description": "Bowtie2 alignment mode",
"help_text": "Bowtie2 alignment mode options, for example: `--very-fast` , `--very-sensitive-local -N 1` , ... Must be used like this: --bowtie2_mode=\"--very-sensitive\""
},
"save_assembly_mapped_reads": {
"type": "boolean",
"description": "Save the output of mapping raw reads back to assembled contigs",
"help_text": "Specify to save the BAM and BAI files generated when mapping input reads back to the assembled contigs (performed in preparation for binning and contig depth estimations)."
},
"bin_domain_classification": {
"type": "boolean",
"description": "Enable domain-level (prokaryote or eukaryote) classification of bins using Tiara. Processes which are domain-specific will then only receive bins matching the domain requirement.",
"help_text": "Enable this if it is likely that your metagenome samples contain a mixture of eukaryotic and prokaryotic genomes. This will ensure that prokaryote-only steps only receive putatively prokaryotic genomes, and vice-versa. Additionally, may improve the performance of DAS Tool by ensuring it only receives prokaryotic genomes."
},
"bin_domain_classification_tool": {
"type": "string",
"default": "tiara",
"description": "Specify which tool to use for domain classification of bins. Currently only 'tiara' is implemented.",
"hidden": true
},
"tiara_min_length": {
"type": "integer",
"default": 3000,
"description": "Minimum contig length for Tiara to use for domain classification. For accurate classification, should be longer than 3000 bp."
}
}
},
"bin_quality_check_options": {
"title": "Bin quality check options",
"type": "object",
"description": "",
"default": "",
"properties": {
"skip_binqc": {
"type": "boolean",
"description": "Disable bin QC with BUSCO or CheckM."
},
"binqc_tool": {
"type": "string",
"default": "busco",
"description": "Specify which tool for bin quality-control validation to use.",
"enum": ["busco", "checkm"]
},
"busco_db": {
"type": "string",
"description": "Download URL for BUSCO lineage dataset, or path to a tar.gz archive, or local directory containing already downloaded and unpacked lineage datasets.",
"help_text": "E.g. https://busco-data.ezlab.org/v5/data/lineages/bacteria_odb10.2024-01-08.tar.gz or '/path/to/buscodb' (files still need to be unpacked manually). Available databases are listed here: https://busco-data.ezlab.org/v5/data/lineages/."
},
"busco_auto_lineage_prok": {
"type": "boolean",
"description": "Run BUSCO with automated lineage selection, but ignoring eukaryotes (saves runtime)."
},
"save_busco_db": {
"type": "boolean",
"description": "Save the used BUSCO lineage datasets provided via `--busco_db`.",
"help_text": "Useful to allow reproducibility, as BUSCO datasets are frequently updated and old versions do not always remain accessible."
},
"busco_clean": {
"type": "boolean",
"description": "Enable clean-up of temporary files created during BUSCO runs.",
"help_text": "By default, BUSCO creates a large number of intermediate files every run. This may cause problems on some clusters which have file number limits in plate, particularly with large numbers of bins. Enabling this option cleans these files, reducing the total file count of the work directory."
},
"checkm_download_url": {
"type": "string",
"default": "https://data.ace.uq.edu.au/public/CheckM_databases/checkm_data_2015_01_16.tar.gz",
"hidden": true,
"description": "URL pointing to checkM database for auto download, if local path not supplied.",
"help_text": "You can use this parameter to point to an online copy of the checkM database TAR archive that the pipeline will use for auto download if a local path is not supplied to `--checkm_db`."
},
"checkm_db": {
"type": "string",
"description": "Path to local folder containing already downloaded and uncompressed CheckM database.",
"help_text": "The pipeline can also download this for you if not specified, and you can save the resulting directory into your output directory by specifying `--save_checkm_data`. You should move this directory to somewhere else on your machine (and supply back to the pipeline in future runs again with `--checkm_db`."
},
"save_checkm_data": {
"type": "boolean",
"description": "Save the used CheckM reference files downloaded when not using --checkm_db parameter.",
"help_text": "If specified, the directories and files decompressed from the `tar.gz` file downloaded from the [CheckM FTP server](https://data.ace.uq.edu.au/public/CheckM_databases/) will be stored in your output directory alongside your CheckM results."
},
"refine_bins_dastool": {
"type": "boolean",
"description": "Turn on bin refinement using DAS Tool."
},
"refine_bins_dastool_threshold": {
"type": "number",
"default": 0.5,
"description": "Specify single-copy gene score threshold for bin refinement.",
"help_text": "Score threshold for single-copy gene selection algorithm to keep selecting bins, with a value ranging from 0-1.\n\nFor description of scoring algorithm, see: Sieber, Christian M. K., et al. 2018. Nature Microbiology 3 (7): 836\u201343. https://doi.org/10.1038/s41564-018-0171-1.\n\n> Modifies DAS Tool parameter --score_threshold\n"
},
"postbinning_input": {
"type": "string",
"default": "raw_bins_only",
"description": "Specify which binning output is sent for downstream annotation, taxonomic classification, bin quality control etc.",
"help_text": "`raw_bins_only`: only bins (and unbinned contigs) from the binners.\n`refined_bins_only`: only bins (and unbinned contigs) from the bin refinement step .\n\n ~~`both`: bins and unbinned contigs from both the binning and bin refinement steps.~~ `both` option is disabled in v2.4 due a bug that will be fixed in a later release.",
"enum": ["raw_bins_only", "refined_bins_only", "both"]
},
"run_gunc": {
"type": "boolean",
"description": "Turn on GUNC genome chimerism checks"
},
"gunc_db": {
"type": "string",
"description": "Specify a path to a pre-downloaded GUNC dmnd database file"
},
"gunc_database_type": {
"type": "string",
"default": "progenomes",
"description": "Specify which database to auto-download if not supplying own",
"enum": ["progenomes", "gtdb"]
},
"gunc_save_db": {
"type": "boolean",
"description": "Save the used GUNC reference files downloaded when not using --gunc_db parameter.",
"help_text": "If specified, the corresponding DIAMOND file downloaded from the GUNC server will be stored in your output directory alongside your GUNC results."
}
}
},
"ancient_dna_assembly": {
"title": "Ancient DNA assembly",
"type": "object",
"description": "Performs ancient DNA assembly validation and contig consensus sequence recalling.",
"default": "",
"properties": {
"ancient_dna": {
"type": "boolean",
"description": "Turn on/off the ancient DNA subworfklow"
},
"pydamage_accuracy": {
"type": "number",
"default": 0.5,
"description": "PyDamage accuracy threshold"
},
"skip_ancient_damagecorrection": {
"type": "boolean",
"description": "deactivate damage correction of ancient contigs using variant and consensus calling"
},
"freebayes_ploidy": {
"type": "integer",
"default": 1,
"description": "Ploidy for variant calling"
},
"freebayes_min_basequality": {
"type": "integer",
"default": 20,
"description": "minimum base quality required for variant calling"
},
"freebayes_minallelefreq": {
"type": "number",
"default": 0.33,
"description": "minimum minor allele frequency for considering variants"
},
"bcftools_view_high_variant_quality": {
"type": "integer",
"default": 30,
"description": "minimum genotype quality for considering a variant high quality"
},
"bcftools_view_medium_variant_quality": {
"type": "integer",
"default": 20,
"description": "minimum genotype quality for considering a variant medium quality"
},
"bcftools_view_minimal_allelesupport": {
"type": "integer",
"default": 3,
"description": "minimum number of bases supporting the alternative allele"
}
}
}
},
"allOf": [
{
"$ref": "#/definitions/input_output_options"
},
{
"$ref": "#/definitions/reference_genome_options"
},
{
"$ref": "#/definitions/institutional_config_options"
},
{
"$ref": "#/definitions/max_job_request_options"
},
{
"$ref": "#/definitions/generic_options"
},
{
"$ref": "#/definitions/reproducibility_options"
},
{
"$ref": "#/definitions/quality_control_for_short_reads_options"
},
{
"$ref": "#/definitions/quality_control_for_long_reads_options"
},
{
"$ref": "#/definitions/taxonomic_profiling_options"
},
{
"$ref": "#/definitions/assembly_options"
},
{
"$ref": "#/definitions/gene_prediction_and_annotation_options"
},
{
"$ref": "#/definitions/virus_identification_options"
},
{
"$ref": "#/definitions/binning_options"
},
{
"$ref": "#/definitions/bin_quality_check_options"
},
{
"$ref": "#/definitions/ancient_dna_assembly"
}
]
}