-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathnextflow_schema.json
767 lines (767 loc) · 38.3 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
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://raw.githubusercontent.com/socialgene/sgnf/master/nextflow_schema.json",
"title": "socialgene/sgnf pipeline parameters",
"description": "Scalable genome mining with SocialGene knowledge graphs",
"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": [],
"properties": {
"genbank_csv": {
"type": "string",
"mimetype": "text/csv",
"format": "file-path-pattern",
"exists": true,
"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"
},
"fasta_csv": {
"type": "string",
"mimetype": "text/csv",
"format": "file-path-pattern",
"exists": true,
"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"
},
"fna_csv": {
"type": "string",
"mimetype": "text/csv",
"format": "file-path-pattern",
"exists": true,
"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"
}
}},
"input_genomes": {
"title": "Input Genomes",
"type": "object",
"description": "Any one or more of the following can be used to download/input genomes for the pipeline",
"default": "",
"properties": {
"ncbi_genome_download_command": {
"type": "string",
"description": "Arguments to pass to ncbi_genome_download_command",
"help_text": "See the following link for more info about commands you can use:\nhttps://github.com/kblin/ncbi-genome-download"
},
"ncbi_datasets_command": {
"type": "string",
"description": "Taxonomic name (maybe NCBI taxonomy id as well?) see extended help before using",
"help_text": "Note/Warning: \nSpecifying a taxon directly has the potential to download a large number of genomes that you may not be prepared to handle.\nI highly recommend searching here (https://www.ncbi.nlm.nih.gov/genome/browse#!/prokaryotes/) first to get an idea of how many input genomes you can expect.\n\n\nThe input argument you provide s replace the `$params.ncbi_datasets_command` in the command below:\n\n`datasets download $params.ncbi_datasets_command --dehydrated $args`\n\nThe value of `$args` is set in https://github.com/socialgene/sgnf/blob/main/conf/modules.config\n\nInfo on use of NCBI datasets can be found here: https://www.ncbi.nlm.nih.gov/datasets/docs/v1/reference-docs/command-line/datasets/"
},
"ncbi_datasets_file": {
"type": "string",
"description": "Instead of using the 'ncbi_datasets_command', the path to a file of NCBI genome accessions to download can provided (single accessio per line)"
},
"local_genbank": {
"type": "string",
"description": "Path to local GenBank file(s), can be a glob",
"help_text": "Accepted files:\ngbff, gbk\nand gzipped versions of those\n"
},
"local_faa": {
"type": "string",
"description": "Path to local protein FASTA file(s), can be a glob"
},
"local_fna": {
"type": "string",
"description": "Path to local assemblies in nucleotide format (to be annotated with Prokka)"
},
"paired_omics_json_path": {
"type": "string",
"description": "Paired omics json file, downloaded from: https://pairedomicsdata.bioinformatics.nl/projects",
"hidden": true
},
"mibig": {
"type": "boolean",
"description": "Set to true to download and include all MIBiG BGCs as input"
},
"genbank_input_buffer": {
"type": "integer",
"default": 50,
"description": "How many genbank files will be processed in a single task",
"help_text": "Decides how many parallel processes will be used for genbank parsing; number of spawned parse processes = (# of input genomes) / (genbank_input_buffer)"
},
"defline_magic": {
"type": "boolean",
"help_text": "set to true if input fasta files contain uniprot deflines (sp| or tr|) (e.g. from uniprot fasta downloads) named defline_magic because may expand to other defline formats in the future",
"description": "set to true if input fasta files contain uniprot deflines (sp| or tr|)",
"hidden": true
}
}
},
"output_directories": {
"title": "Output Directories",
"type": "object",
"fa_icon": "fas fa-terminal",
"description": "Define where the pipeline should find input data and save output data.",
"properties": {
"outdir": {
"type": "string",
"description": "If set, and others not, all other outdirs within this directory",
"fa_icon": "fas fa-folder-open",
"default": "socialgene_results"
},
"outdir_download_cache": {
"type": "string",
"description": "Long term caching directory for use between different pipeline runs.",
"fa_icon": "fas fa-folder-open",
"default": "${params.outdir}/socialgene_long_cache",
"hidden": true
},
"outdir_per_run": {
"type": "string",
"description": "Directory that holds data generated each run",
"fa_icon": "fas fa-folder-open",
"default": "${params.outdir}/socialgene_per_run",
"hidden": true
},
"outdir_neo4j": {
"type": "string",
"description": "Path to the output directory where the results will be saved.",
"default": "${params.outdir}/socialgene_neo4j",
"fa_icon": "fas fa-folder-open",
"hidden": true
},
"outdir_genomes": {
"type": "string",
"default": "${params.outdir_per_run}",
"description": "Storage directory for downloaded genomes",
"fa_icon": "fas fa-folder-open",
"hidden": true
},
"outdir_blast_cache": {
"type": "string",
"default": "${params.outdir}/socialgene_per_run/blastp_cache",
"fa_icon": "fas fa-folder-open",
"description": "Cache folder where blast results are written to. Important to delete if starting a new pipeline run with different input data but using same cache directory as a previous run.",
"hidden": true
},
"tracedir": {
"type": "string",
"description": "Directory to keep pipeline Nextflow logs and reports.",
"default": "${params.outdir}/pipeline_info",
"fa_icon": "fas fa-folder-open",
"hidden": true
}
},
"required": ["outdir"]
},
"socialgene_parameters": {
"title": "SocialGene Parameters",
"type": "object",
"description": "",
"default": "",
"properties": {
"fasta_splits": {
"type": "integer",
"default": 1,
"description": "Split non-redundant protein sequences into n-FASTA files",
"help_text": "Use this to run HMMER in parallel/make things faster. Determines how many FASTA files should be the created from all non-redundant protein sequences"
},
"hmm_splits": {
"type": "integer",
"default": 1,
"description": "For most use cases keep this at 1 and increase fasta_splits instead",
"help_text": "Determines how many hmm files should be created to run in parallel. This is mainly for making smaller files for massively parallel distribution on CHTC"
},
"include_sequences": {
"type": "boolean",
"description": "Include protein sequences in the Neo4j database?",
"default": true
},
"antismash_fulljson": {
"type": "boolean",
"description": "Keep full antismash output json? Can take up a lot of space for large datasets",
"hidden": true,
"default": true
}
}
},
"socialgene_modules": {
"title": "SocialGene modules",
"type": "object",
"description": "These determine the annotations and structure of the resulting database",
"default": "",
"properties": {
"build_database": {
"type": "boolean",
"default": true,
"description": "Should the Neo4j databse be created?"
},
"blastp": {
"type": "boolean",
"description": "Should all vs all BLASTp be run? DO NOT RUN ON LARGE INPUT DATA WITHOUT STRICT FILTERS"
},
"hmmlist": {
"type": "string",
"description": "Comma-separated string (e.g. 'antismash,amrfinder) or 'all', see extended help for all options",
"help_text": "antismash,amrfinder,bigslice,classiphage, ipresto,pfam,prism,resfams,tigrfam,virus_orthologous_groups",
"hidden": true
},
"mmseqs_steps": {
"type": "string",
"description": "Descending, comma-delimited string of levels to cluster to- e.g. '90,80,70''"
},
"ncbi_taxonomy": {
"type": "boolean",
"description": "Download and insert the NCBI taxonomy database? Requires input assemblies to have NCBI Assembly accessions"
},
"antismash": {
"type": "boolean",
"description": "Run antismash on all input genomes"
},
"chembl": {
"type": "boolean",
"description": "Include chembl data into database Not yet implemented",
"hidden": true
},
"paired_omics": {
"type": "boolean",
"description": "Not yet implemented",
"hidden": true
},
"goterms": {
"type": "boolean",
"description": "Download and process go term ontology"
}
}
},
"max_job_resources": {
"title": "Max Job Resources",
"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 these values only set the max, to increase the actual resources requested by any single process you will need to set up 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": 8,
"fa_icon": "fas fa-microchip",
"help_text": "Used to set an upper-limit for the number of CPUs that can be used at once. Should be an integer e.g. `--max_cpus 1`\n\nhttps://www.nextflow.io/docs/latest/process.html#process-cpus"
},
"max_memory": {
"type": "string",
"description": "Maximum amount of memory that can be requested for any single job.",
"default": "24.GB",
"fa_icon": "fas fa-memory",
"pattern": "^\\d+(\\.\\d+)?\\.?\\s*(K|M|G|T)?B$",
"help_text": "Used to set an upper-limit for the memory any single process can use. Should be a string in the format integer-unit e.g. `--max_memory '8.GB'`\n\nhttps://www.nextflow.io/docs/latest/process.html#process-memory"
},
"max_time": {
"type": "string",
"description": "Maximum amount of time that can be requested for any single job.",
"default": "24.h",
"fa_icon": "far fa-clock",
"pattern": "^(\\d+\\.?\\s*(s|m|h|d|day)\\s*)+$",
"help_text": "Used to set an upper-limit for the amount of time any single process is allowed to run. Should be a string in the format integer-unit e.g. `--max_time '2.h'`\n\nhttps://www.nextflow.io/docs/latest/process.html#time"
},
"slurm_queue_size": {
"type": "integer",
"default": 15,
"hidden": true,
"description": "Number of slurm jobs that can be running/submitted"
}
}
},
"advanced_hmm_input": {
"title": "Advanced HMM Input",
"type": "object",
"description": "Any one or more of the following can be used to download/input HMMs for the pipeline",
"default": "",
"properties": {
"custom_hmm_file": {
"type": "string",
"description": "File path of a custom HMMER hmm file",
"hidden": true
},
"domtblout_path": {
"type": "string",
"description": "Use externally-generated domtblout files. Please read the long description before using",
"help_text": "Use externally-generated domtblout files.\nThe models have to have the same name (identifier) as SocialGene expects, which is a SocialGene-generated hash of the HMM model",
"hidden": true
},
"domtblout_with_ga": {
"type": "string",
"description": "Path to hmmsearch results that used cutoffs",
"hidden": true
},
"domtblout_without_ga": {
"type": "string",
"description": "Path to hmmsearch results that didn't use cutoffs",
"hidden": true
}
}
},
"hmmer_options": {
"title": "HMMER Options",
"type": "object",
"description": "",
"default": "",
"properties": {
"hmmsearch_model_threshold": {
"type": "string",
"default": "--cut_ga",
"description": "--cut_ga or --cut_nc or --cut_tc",
"help_text": "From HMMER documentation:\nOptions controlling model-specific thresholding:\n\n--cut_ga : use profile's GA gathering cutoffs to set all thresholding\n\n--cut_nc : use profile's NC noise cutoffs to set all thresholding\n\n--cut_tc : use profile's TC trusted cutoffs to set all thresholding\n",
"hidden": true
},
"HMMSEARCH_Z": {
"type": "integer",
"default": 100000000,
"description": "see pg 74-77: http://eddylab.org/software/hmmer3/3.1b2/Userguide.pdf",
"hidden": true
},
"HMMSEARCH_IEVALUE": {
"type": "number",
"default": 0.1,
"description": "see pg 74-77: http://eddylab.org/software/hmmer3/3.1b2/Userguide.pdf",
"hidden": true
},
"HMMSEARCH_E": {
"type": "number",
"default": 100,
"description": "see pg 74-77: http://eddylab.org/software/hmmer3/3.1b2/Userguide.pdf",
"hidden": true
},
"HMMSEARCH_DOME": {
"type": "number",
"default": 10,
"description": "see pg 74-77: http://eddylab.org/software/hmmer3/3.1b2/Userguide.pdf",
"hidden": true
},
"HMMSEARCH_INCE": {
"type": "number",
"default": 0.001,
"description": "see pg 74-77: http://eddylab.org/software/hmmer3/3.1b2/Userguide.pdf",
"hidden": true
},
"HMMSEARCH_INCDOME": {
"type": "number",
"default": 0.001,
"description": "see pg 74-77: http://eddylab.org/software/hmmer3/3.1b2/Userguide.pdf",
"hidden": true
},
"HMMSEARCH_SEED": {
"type": "integer",
"default": 42,
"description": "see pg 74-77: http://eddylab.org/software/hmmer3/3.1b2/Userguide.pdf",
"hidden": true
},
"HMMSEARCH_F1": {
"type": "number",
"default": 0.02,
"description": "see pg 74-77: http://eddylab.org/software/hmmer3/3.1b2/Userguide.pdf",
"hidden": true
},
"HMMSEARCH_F2": {
"type": "number",
"default": 0.001,
"description": "see pg 74-77: http://eddylab.org/software/hmmer3/3.1b2/Userguide.pdf",
"hidden": true
},
"HMMSEARCH_F3": {
"type": "number",
"default": 1e-5,
"description": "see pg 74-77: http://eddylab.org/software/hmmer3/3.1b2/Userguide.pdf",
"hidden": true
}
}
},
"external_data_versions": {
"title": "External Data Versions",
"type": "object",
"description": "",
"default": "",
"properties": {
"amrfinder_version": {
"type": "string",
"default": "2024-05-02.2",
"hidden": true,
"description": "Version of amrfinder to download/use"
},
"bigslice_version": {
"type": "string",
"default": "v1.0.0/bigslice-models.2020-04-27",
"hidden": true,
"description": "Version of bigslice to download/use"
},
"vog_version": {
"type": "string",
"default": "vog211",
"hidden": true,
"description": "Version of vog to download/use"
},
"tigrfam_version": {
"type": "string",
"default": "15",
"hidden": true,
"description": "Version of tigrfam to download/use"
},
"pfam_version": {
"type": "string",
"default": "37.0",
"description": "PFAM version. Ffor version numbers see: http://ftp.ebi.ac.uk/pub/databases/Pfam/releases",
"hidden": true
},
"antismash_hmms_git_sha": {
"type": "string",
"default": "8fd065a63e99ee628b536cc19fa66d5942b784ea",
"description": "Controls which version of antismash the antismash HMMS are pulled from",
"hidden": true
},
"chembl_version": {
"type": "string",
"description": "Set (e.g. '31' for chembl version 31) to incorporate chembl into the database",
"hidden": true,
"default": "31"
}
}
},
"htcondor_specific_parameters": {
"title": "HTCONDOR specific parameters",
"type": "object",
"description": "These parameters are specific to UW-Madison's CHTC high throuput computing cluster",
"default": "",
"properties": {
"htcondor": {
"type": "boolean",
"hidden": true,
"description": "Use the --htcondor flag to create files for htcondor, then run again with the results from the external run",
"help_text": "When --htcondor is set the pipeline will only run the steps required to generate and split the non-redundant FASTA file and HMM models for running on external hardware. (Don't delete the work directory until after the next step completes) This will result in a directory `$outdir/htcondor_cache` which contains all the data and scripts and instructions necessary to run highly-parallel `hmmsearch` on CHTC. Then the pipeline is run again, but replacing `--htcondor` with `--domtblout_path` and `--resume`, at which point the rest of the modules will also run.\n(Don't delete the work directory until all steps above complete)\n\nSee `https://github.com/socialgene/sgnf/blob/main/conf/examples/htcondor.config` for an example"
},
"htcondor_request_memory": {
"type": "string",
"default": "1GB",
"hidden": true,
"description": "See: https://chtc.cs.wisc.edu/uw-research-computing/helloworld"
},
"htcondor_request_cpus": {
"type": "integer",
"default": 1,
"hidden": true,
"description": "See: https://chtc.cs.wisc.edu/uw-research-computing/helloworld"
},
"htcondor_request_disk": {
"type": "string",
"default": "5GB",
"hidden": true,
"description": "See: https://chtc.cs.wisc.edu/uw-research-computing/helloworld"
},
"htcondor_max_idle": {
"type": "integer",
"default": 100,
"hidden": true,
"description": "See: https://chtc.cs.wisc.edu/uw-research-computing/helloworld"
},
"htcondor_squid_username": {
"type": "string",
"default": "cmclark8",
"hidden": true,
"description": "See: https://chtc.cs.wisc.edu/uw-research-computing/file-avail-squid"
},
"htcondor_WantGlideIn": {
"type": "boolean",
"default": true,
"hidden": true,
"description": "See: https://chtc.cs.wisc.edu/uw-research-computing/helloworld"
},
"htcondor_WantFlocking": {
"type": "boolean",
"default": true,
"hidden": true,
"description": "See: https://chtc.cs.wisc.edu/uw-research-computing/helloworld"
},
"htcondor_prep_directory": {
"type": "string",
"default": "socialgene_results/htcondor_cache",
"hidden": true,
"description": "Where data to be sent to CHTC will be written"
}
}
},
"multiqc": {
"title": "MULTIQC",
"type": "object",
"description": "",
"default": "",
"properties": {
"multiqc_title": {
"type": "string",
"description": "x",
"hidden": true
},
"multiqc_logo": {
"type": "string",
"description": "x",
"hidden": true
},
"multiqc_config": {
"type": "string",
"description": "x",
"hidden": true
},
"max_multiqc_email_size": {
"type": "string",
"default": "25.MB",
"description": "x",
"hidden": true
},
"multiqc_methods_description": {
"type": "string",
"description": "x",
"hidden": true
}
}
},
"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
},
"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
},
"monochrome_logs": {
"type": "boolean",
"description": "Do not use coloured log outputs.",
"fa_icon": "fas fa-palette",
"hidden": true
},
"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."
},
"hook_url": {
"type": "string",
"hidden": true,
"description": "x"
},
"version": {
"type": "boolean",
"description": "Display version and exit.",
"fa_icon": "fas fa-question-circle",
"hidden": true
},
"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})$",
"hidden": true
},
"input": {
"type": "string",
"description": "not used, required by nf-core linter",
"hidden": true
},
"sort_fasta": {
"type": "boolean",
"description": "BLAST (and maybe MMseqs2?) differ based on sequence order, setting this to true will sort the protein fasta file first (note: this will make a copy of the data)",
"hidden": true
},
"publish_dir_mode": {
"type": "string",
"default": "copy",
"description": "mode for publishing results form work directories"
}
}
},
"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"
}
}
},
"docker_images": {
"title": "Docker Images",
"type": "object",
"description": "Change the docker image tags (advanced, for developers)",
"default": "",
"properties": {
"sgnf_antismash_dockerimage": {
"type": "string",
"hidden": true,
"description": "Specify which docker image tag to use (default is the version synced to pipeline version number)"
},
"sgnf_hmmer_dockerimage": {
"type": "string",
"hidden": true,
"description": "Specify which docker image tag to use (default is the version synced to pipeline version number)"
},
"sgnf_hmmer_plus_dockerimage": {
"type": "string",
"hidden": true,
"description": "Specify which docker image tag to use (default is the version synced to pipeline version number)"
},
"sgnf_sgpy_dockerimage": {
"type": "string",
"hidden": true,
"description": "Specify which docker image tag to use (default is the version synced to pipeline version number)"
},
"sgnf_minimal_dockerimage": {
"type": "string",
"hidden": true,
"description": "Specify which docker image tag to use (default is the version synced to pipeline version number)"
}
}
},
"validation": {
"title": "Validation",
"type": "object",
"description": "",
"default": "",
"properties": {
"validationFailUnrecognisedParams": {
"type": "boolean",
"hidden": true
},
"validationLenientMode": {
"type": "boolean",
"hidden": true
}
}
}
},
"allOf": [
{
"$ref": "#/definitions/input_output_options"
},
{
"$ref": "#/definitions/input_genomes"
},
{
"$ref": "#/definitions/output_directories"
},
{
"$ref": "#/definitions/socialgene_parameters"
},
{
"$ref": "#/definitions/socialgene_modules"
},
{
"$ref": "#/definitions/max_job_resources"
},
{
"$ref": "#/definitions/advanced_hmm_input"
},
{
"$ref": "#/definitions/hmmer_options"
},
{
"$ref": "#/definitions/external_data_versions"
},
{
"$ref": "#/definitions/htcondor_specific_parameters"
},
{
"$ref": "#/definitions/multiqc"
},
{
"$ref": "#/definitions/generic_options"
},
{
"$ref": "#/definitions/institutional_config_options"
},
{
"$ref": "#/definitions/docker_images"
},
{
"$ref": "#/definitions/validation"
}
],
"properties": {
"prism_hmms_git_sha": {
"type": "string",
"default": "4bf8bbdf2da3b4f1c764de2301be7b02e74af157"
},
"fasta_csv": {
"type": "string"
},
"genbank_csv": {
"type": "string"
},
"fna_csv": {
"type": "string"
}
}
}