forked from EBI-Metagenomics/emg-viral-pipeline
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathvirify.nf
executable file
·697 lines (592 loc) · 25.2 KB
/
virify.nf
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
#!/usr/bin/env nextflow
nextflow.enable.dsl=2
/*
* Nextflow -- Virus Analysis Pipeline
* Author: [email protected]
*/
/**************************
* Help messages & user inputs & checks
**************************/
/* Comment section:
First part is a terminal print for additional user information, followed by some help statements (e.g. missing input)
Second part is file channel input. This allows via --list to alter the input of --nano & --illumina to
add csv instead. name,path or name,pathR1,pathR2 in case of illumina
*/
// terminal prints
println " "
println "\u001B[32mProfile: $workflow.profile\033[0m"
println " "
println "\033[2mCurrent User: $workflow.userName"
println "Nextflow-version: $nextflow.version"
println "Starting time: $nextflow.timestamp"
println "Workdir location:"
println " $workflow.workDir"
println "Databases location:"
println " $params.databases\u001B[0m"
println " "
if (workflow.profile == 'standard') {
println "\033[2mCPUs to use: $params.cores"
println "Output dir name: $params.output\u001B[0m"
println " "
}
println "\033[2mDev ViPhOG database: $params.viphog_version\u001B[0m"
println "\033[2mDev Meta database: $params.meta_version\u001B[0m"
println " "
println "\033[2mOnly run annotation: $params.onlyannotate\u001B[0m"
println " "
if( !nextflow.version.matches('20.01+') ) {
println "This workflow requires Nextflow version 20.01 or greater -- You are running version $nextflow.version"
exit 1
}
if (params.help) { exit 0, helpMSG() }
if (params.profile) {
exit 1, "--profile is WRONG use -profile" }
if (params.illumina == '' && params.fasta == '' ) {
exit 1, "input missing, use [--illumina] or [--fasta]"}
/**************************
* INPUT CHANNELS
**************************/
// illumina reads input & --list support
if (params.illumina && params.list) { illumina_input_ch = Channel
.fromPath( params.illumina, checkIfExists: true )
.splitCsv()
.map { row -> ["${row[0]}", [file("${row[1]}"), file("${row[2]}")]] }
}
else if (params.illumina) { illumina_input_ch = Channel
.fromFilePairs( params.illumina , checkIfExists: true )
}
// direct fasta input w/o assembly support & --list support
if (params.fasta && params.list) { fasta_input_ch = Channel
.fromPath( params.fasta, checkIfExists: true )
.splitCsv()
.map { row -> ["${row[0]}", file("${row[1]}")] }
}
else if (params.fasta) { fasta_input_ch = Channel
.fromPath( params.fasta, checkIfExists: true)
.map { file -> tuple(file.simpleName, file) }
}
// mashmap input
if (params.mashmap) { mashmap_ref_ch = Channel
.fromPath( params.mashmap, checkIfExists: true)
}
/**************************
* MODULES
**************************/
/* Comment section: */
//db
include {pprmetaGet} from './nextflow/modules/pprmeta'
include {metaGetDB} from './nextflow/modules/metaGetDB'
include {virsorterGetDB} from './nextflow/modules/virsorterGetDB'
include {viphogGetDB} from './nextflow/modules/viphogGetDB'
include {ncbiGetDB} from './nextflow/modules/ncbiGetDB'
include {rvdbGetDB} from './nextflow/modules/rvdbGetDB'
include {pvogsGetDB} from './nextflow/modules/pvogsGetDB'
include {vogdbGetDB} from './nextflow/modules/vogdbGetDB'
include {vpfGetDB} from './nextflow/modules/vpfGetDB'
include {imgvrGetDB} from './nextflow/modules/imgvrGetDB'
//include './modules/kaijuGetDB' params(cloudProcess: params.cloudProcess, databases: params.databases)
//preprocessing
include {rename} from './nextflow/modules/rename'
include {restore} from './nextflow/modules/restore'
//assembly (optional)
include {fastp} from './nextflow/modules/fastp'
include {fastqc} from './nextflow/modules/fastqc'
include {multiqc} from './nextflow/modules/multiqc'
include {spades} from './nextflow/modules/spades'
//detection
include {virsorter} from './nextflow/modules/virsorter'
include {virfinder; virfinderGetDB} from './nextflow/modules/virfinder'
include {pprmeta} from './nextflow/modules/pprmeta'
include {length_filtering} from './nextflow/modules/length_filtering'
include {parse} from './nextflow/modules/parse'
include {prodigal} from './nextflow/modules/prodigal'
//include phanotate from './modules/phanotate'
include {hmmscan as hmmscan_viphogs} from './nextflow/modules/hmmscan' params(output: params.output, hmmerdir: params.hmmerdir, db: 'viphogs', version: params.viphog_version)
include {hmmscan as hmmscan_rvdb} from './nextflow/modules/hmmscan' params(output: params.output, hmmerdir: params.hmmerdir, db: 'rvdb', version: params.viphog_version)
include {hmmscan as hmmscan_pvogs} from './nextflow/modules/hmmscan' params(output: params.output, hmmerdir: params.hmmerdir, db: 'pvogs', version: params.viphog_version)
include {hmmscan as hmmscan_vogdb} from './nextflow/modules/hmmscan' params(output: params.output, hmmerdir: params.hmmerdir, db: 'vogdb', version: params.viphog_version)
include {hmmscan as hmmscan_vpf} from './nextflow/modules/hmmscan' params(output: params.output, hmmerdir: params.hmmerdir, db: 'vpf', version: params.viphog_version)
include {hmm_postprocessing} from './nextflow/modules/hmm_postprocessing'
include {ratio_evalue} from './nextflow/modules/ratio_evalue'
include {annotation} from './nextflow/modules/annotation'
include {assign} from './nextflow/modules/assign'
include {blast} from './nextflow/modules/blast'
include {blast_filter} from './nextflow/modules/blast_filter'
include {mashmap} from './nextflow/modules/mashmap'
//visuals
include plot_contig_map from './nextflow/modules/plot_contig_map'
include generate_krona_table from './nextflow/modules/krona'
include generate_sankey_table from './nextflow/modules/sankey'
include generate_chromomap_table from './nextflow/modules/chromomap'
include krona from './nextflow/modules/krona'
include sankey from './nextflow/modules/sankey'
include chromomap from './nextflow/modules/chromomap'
include balloon from './nextflow/modules/balloon'
//include './modules/kaiju' params(output: params.output, illumina: params.illumina, fasta: params.fasta)
//include './modules/filter_reads' params(output: params.output)
/**************************
* DATABASES
**************************/
/* Comment section:
The Database Section is designed to "auto-get" pre prepared databases.
It is written for local use and cloud use.*/
workflow download_pprmeta {
main:
// local storage via storeDir
if (!params.cloudProcess) { pprmetaGet(); git = pprmetaGet.out }
// cloud storage via preload.exists()
if (params.cloudProcess) {
preload = file("${params.databases}/pprmeta")
if (preload.exists()) { git = preload }
else { pprmetaGet(); git = pprmetaGet.out }
}
emit: git
}
workflow download_model_meta {
main:
// local storage via storeDir
if (!params.cloudProcess) { metaGetDB(); db = metaGetDB.out }
// cloud storage via preload.exists()
if (params.cloudProcess) {
preload = file("${params.databases}/models/additional_data_vpHMMs_${params.meta_version}.tsv")
if (preload.exists()) { db = preload }
else { metaGetDB(); db = metaGetDB.out }
}
emit: db
}
workflow download_virsorter_db {
main:
// local storage via storeDir
if (!params.cloudProcess) { virsorterGetDB(); db = virsorterGetDB.out }
// cloud storage via db_preload.exists()
if (params.cloudProcess) {
db_preload = file("${params.databases}/virsorter/virsorter-data")
if (db_preload.exists()) { db = db_preload }
else { virsorterGetDB(); db = virsorterGetDB.out }
}
emit: db
}
workflow download_virfinder_db {
main:
// local storage via storeDir
if (!params.cloudProcess) { virfinderGetDB(); db = virfinderGetDB.out }
// cloud storage via db_preload.exists()
if (params.cloudProcess) {
db_preload = file("${params.databases}/virfinder/VF.modEPV_k8.rda")
if (db_preload.exists()) { db = db_preload }
else { virfinderGetDB(); db = virfinderGetDB.out }
}
emit: db
}
workflow download_viphog_db {
main:
// local storage via storeDir
if (!params.cloudProcess) { viphogGetDB(); db = viphogGetDB.out }
// cloud storage via db_preload.exists()
if (params.cloudProcess) {
db_preload = file("${params.databases}/vpHMM_database_${params.viphog_version}")
if (db_preload.exists()) { db = db_preload }
else { viphogGetDB(); db = viphogGetDB.out }
}
emit: db
}
workflow download_ncbi_db {
main:
// local storage via storeDir
if (!params.cloudProcess) { ncbiGetDB(); db = ncbiGetDB.out }
// cloud storage via db_preload.exists()
if (params.cloudProcess) {
db_preload = file("${params.databases}/ncbi/ete3_ncbi_tax.sqlite")
if (db_preload.exists()) { db = db_preload }
else { ncbiGetDB(); db = ncbiGetDB.out }
}
emit: db
}
workflow download_rvdb_db {
main:
if (params.hmmextend) {
// local storage via storeDir
if (!params.cloudProcess) { rvdbGetDB(); db = rvdbGetDB.out }
// cloud storage via db_preload.exists()
if (params.cloudProcess) {
db_preload = file("${params.databases}/rvdb")
if (db_preload.exists()) { db = db_preload }
else { rvdbGetDB(); db = rvdbGetDB.out }
}
} else {
db = Channel.empty()
}
emit: db
}
workflow download_pvogs_db {
main:
if (params.hmmextend) {
// local storage via storeDir
if (!params.cloudProcess) { pvogsGetDB(); db = pvogsGetDB.out }
// cloud storage via db_preload.exists()
if (params.cloudProcess) {
db_preload = file("${params.databases}/pvogs")
if (db_preload.exists()) { db = db_preload }
else { pvogsGetDB(); db = pvogsGetDB.out }
}
} else {
db = Channel.empty()
}
emit: db
}
workflow download_vogdb_db {
main:
if (params.hmmextend) {
// local storage via storeDir
if (!params.cloudProcess) { vogdbGetDB(); db = vogdbGetDB.out }
// cloud storage via db_preload.exists()
if (params.cloudProcess) {
db_preload = file("${params.databases}/vogdb")
if (db_preload.exists()) { db = db_preload }
else { vogdbGetDB(); db = vogdbGetDB.out }
}
} else {
db = Channel.empty()
}
emit: db
}
workflow download_vpf_db {
main:
if (params.hmmextend) {
// local storage via storeDir
if (!params.cloudProcess) { vpfGetDB(); db = vpfGetDB.out }
// cloud storage via db_preload.exists()
if (params.cloudProcess) {
db_preload = file("${params.databases}/vpf")
if (db_preload.exists()) { db = db_preload }
else { vpfGetDB(); db = vpfGetDB.out }
}
} else {
db = Channel.empty()
}
emit: db
}
workflow download_imgvr_db {
main:
if (params.blastextend) {
// local storage via storeDir
if (!params.cloudProcess) { imgvrGetDB(); db = imgvrGetDB.out }
// cloud storage via db_preload.exists()
if (params.cloudProcess) {
db_preload = file("${params.databases}/imgvr/IMG_VR_2018-07-01_4")
if (db_preload.exists()) { db = db_preload }
else { imgvrGetDB(); db = imgvrGetDB.out }
}
} else {
db = Channel.empty()
}
emit: db
}
/*
workflow download_kaiju_db {
main:
// local storage via storeDir
if (!params.cloudProcess) { kaijuGetDB(); db = kaijuGetDB.out }
// cloud storage via db_preload.exists()
if (params.cloudProcess) {
db_preload = file("${params.databases}/kaiju/nr_euk")
if (db_preload.exists()) { db = db_preload }
else { kaijuGetDB(); db = kaijuGetDB.out }
}
emit: db
}
*/
/**************************
* SUB WORKFLOWS
**************************/
/* Comment section:
*/
workflow preprocess {
take: assembly
main:
// rename contigs
rename(assembly)
// filter contigs by length
length_filtering(rename.out)
emit:
rename.out.join(length_filtering.out, by: 0) // tuple val(name), file("${name}_renamed.fasta"), file("${name}_map.tsv"), file("${name}*filt*.fasta"), env(CONTIGS)
}
/* Comment section:
*/
workflow postprocess {
take: fasta
main:
// restore contig names
restore(fasta)
emit:
restore.out
}
/* Comment section:
*/
workflow detect {
take: assembly_renamed_length_filtered
virsorter_db
virfinder_db
pprmeta_git
main:
renamed_ch = assembly_renamed_length_filtered.map{name, renamed_fasta, map, filtered_fasta, contig_number -> tuple(name, renamed_fasta, map)}
length_filtered_ch = assembly_renamed_length_filtered.map{name, renamed_fasta, map, filtered_fasta, contig_number -> tuple(name, filtered_fasta, contig_number)}
// virus detection --> VirSorter, VirFinder and PPR-Meta
virsorter(length_filtered_ch, virsorter_db)
virfinder(length_filtered_ch, virfinder_db)
pprmeta(length_filtered_ch, pprmeta_git)
// parsing predictions
parse(length_filtered_ch.join(virfinder.out).join(virsorter.out).join(pprmeta.out))
emit:
parse.out.join(renamed_ch).transpose().map{name, fasta, vs_meta, log, renamed_fasta, map -> tuple (name, fasta, map)}
}
/* Comment section:
*/
workflow annotate {
take: predicted_contigs
viphog_db
ncbi_db
rvdb_db
pvogs_db
vogdb_db
vpf_db
imgvr_db
additional_model_data
main:
// ORF detection --> prodigal
prodigal(predicted_contigs)
//phanotate(predicted_contigs)
// annotation --> hmmer
hmmscan_viphogs(prodigal.out, viphog_db)
hmm_postprocessing(hmmscan_viphogs.out)
// calculate hit qual per protein
ratio_evalue(hmm_postprocessing.out, additional_model_data)
// annotate contigs based on ViPhOGs
annotation(ratio_evalue.out)
// plot visuals --> PDFs
plot_contig_map(annotation.out)
// assign lineages
assign(annotation.out, ncbi_db)
// blast IMG/VR for more information
if (params.blastextend) {
blast(predicted_contigs, imgvr_db)
blast_filter(blast.out, imgvr_db)
}
// hmmer additional databases
if (params.hmmextend) {
hmmscan_rvdb(prodigal.out, rvdb_db)
hmmscan_pvogs(prodigal.out, pvogs_db)
hmmscan_vogdb(prodigal.out, vogdb_db)
hmmscan_vpf(prodigal.out, vpf_db)
}
// mashmap
if (params.mashmap) {
mashmap(predicted_contigs, mashmap_ref_ch)
}
predicted_contigs_filtered = predicted_contigs.map { id, set_name, fasta -> [set_name, id, fasta] }
plot_contig_map_filtered = plot_contig_map.out.map { id, set_name, dir, table -> [set_name, table] }
chromomap_ch = predicted_contigs_filtered.join(plot_contig_map_filtered).map { set_name, assembly_name, fasta, tsv -> [assembly_name, set_name, fasta, tsv]}
emit:
assign.out
chromomap_ch
}
/* Comment section:
*/
workflow plot {
take:
assigned_lineages_ch
annotated_proteins_ch
main:
// krona
combined_assigned_lineages_ch = assigned_lineages_ch.groupTuple().map { tuple(it[0], 'all', it[2]) }.concat(assigned_lineages_ch)
//combined_assigned_lineages_ch.view()
krona(
generate_krona_table(combined_assigned_lineages_ch)
)
// sankey
if (workflow.profile != 'conda') {
sankey(
generate_sankey_table(generate_krona_table.out)
)
}
// chromomap
if (workflow.profile != 'conda' && params.chromomap) {
combined_annotated_proteins_ch = annotated_proteins_ch.groupTuple().map { tuple(it[0], 'all', it[2], it[3]) }.concat(annotated_proteins_ch)
chromomap(
generate_chromomap_table(combined_annotated_proteins_ch)
)
}
// balloon plot
balloon(combined_assigned_lineages_ch)
}
/* Comment section:
Maybe as an pre-step
*/
workflow assemble_illumina {
take: reads
main:
// trimming
fastp(reads)
// read QC
multiqc(fastqc(fastp.out))
// assembly
spades(fastp.out)
emit:
spades.out
}
/**************************
* WORKFLOW ENTRY POINT
**************************/
/* Comment section: */
workflow {
/**************************************************************/
// check/ download all databases
if (params.pprmeta) { pprmeta_git = file(params.pprmeta) }
else { pprmeta_git = download_pprmeta() }
if (params.virsorter) { virsorter_db = file(params.virsorter)}
else { download_virsorter_db(); virsorter_db = download_virsorter_db.out }
if (params.virfinder) { virfinder_db = file(params.virfinder)}
else { download_virfinder_db(); virfinder_db = download_virfinder_db.out }
if (params.meta) { additional_model_data = file(params.meta) }
else { additional_model_data = download_model_meta() }
if (params.viphog) { viphog_db = file(params.viphog)}
else {download_viphog_db(); viphog_db = download_viphog_db.out }
if (params.rvdb) { rvdb_db = file(params.rvdb)}
else {download_rvdb_db(); rvdb_db = download_rvdb_db.out }
if (params.pvogs) { pvogs_db = file(params.pvogs)}
else {download_pvogs_db(); pvogs_db = download_pvogs_db.out }
if (params.vogdb) { vogdb_db = file(params.vogdb)}
else {download_vogdb_db(); vogdb_db = download_vogdb_db.out }
if (params.vpf) { vpf_db = file(params.vpf)}
else {download_vpf_db(); vpf_db = download_vpf_db.out }
if (params.ncbi) { ncbi_db = file(params.ncbi)}
else {download_ncbi_db(); ncbi_db = download_ncbi_db.out }
if (params.imgvr) { imgvr_db = file(params.imgvr)}
else {download_imgvr_db(); imgvr_db = download_imgvr_db.out }
//download_kaiju_db()
//kaiju_db = download_kaiju_db.out
/**************************************************************/
// only detection based on an assembly
if (params.fasta) {
// only annotate the FASTA
if (params.onlyannotate) {
plot(
annotate(
postprocess(
preprocess(
fasta_input_ch).map{name, renamed_fasta, map, filtered_fasta, contig_number -> tuple(name, filtered_fasta, map)}
), viphog_db, ncbi_db, rvdb_db, pvogs_db, vogdb_db, vpf_db, imgvr_db, additional_model_data
)
)
} else {
plot(
annotate(
postprocess(
detect(
preprocess(fasta_input_ch),
virsorter_db, virfinder_db, pprmeta_git
)
), viphog_db, ncbi_db, rvdb_db, pvogs_db, vogdb_db, vpf_db, imgvr_db, additional_model_data
)
)
}
}
// illumina data to build an assembly first
if (params.illumina) {
assemble_illumina(illumina_input_ch)
plot(
annotate(
postprocess(detect(preprocess(assemble_illumina.out), virsorter_db, virfinder_db, pprmeta_git)), viphog_db, ncbi_db, rvdb_db, pvogs_db, vogdb_db, vpf_db, imgvr_db, additional_model_data)
)
}
}
/*************
* --help
*************/
def helpMSG() {
c_green = "\033[0;32m";
c_reset = "\033[0m";
c_yellow = "\033[0;33m";
c_blue = "\033[0;34m";
c_dim = "\033[2m";
log.info """
____________________________________________________________________________________________
VIRify
${c_yellow}Usage example:${c_reset}
nextflow run main.nf --fasta 'assembly.fasta'
${c_yellow}Input:${c_reset}
${c_green} --illumina ${c_reset} '*.R{1,2}.fastq.gz' -> file pairs
${c_green} --fasta ${c_reset} '*.fasta' -> one sample per file, no assembly produced
${c_dim} ..change above input to csv:${c_reset} ${c_green}--list ${c_reset}
${c_yellow}Options:${c_reset}
--cores max cores per process for local use [default: $params.cores]
--max_cores max cores per machine for local use [default: $params.max_cores]
--memory max memory for local use [default: $params.memory]
--output name of the result folder [default: $params.output]
${c_yellow}Databases:${c_reset}
--virsorter a virsorter database provided as 'virsorter/virsorter-data' [default: $params.virsorter]
--virfinder a virfinder model [default: $params.virfinder]
--viphog the ViPhOG database, hmmpress'ed [default: $params.viphog]
--rvdb the RVDB, hmmpress'ed [default: $params.rvdb]
--pvogs the pVOGS, hmmpress'ed [default: $params.pvogs]
--vogdb the VOGDB, hmmpress'ed [default: $params.vogdb]
--vpf the VPF from IMG/VR, hmmpress'ed [default: $params.vpf]
--ncbi a NCBI taxonomy database, from ete3 import NCBITaxa, named ete3_ncbi_tax.sqlite [default: $params.ncbi]
--imgvr the IMG/VR, viral (meta)genome sequences [default: $params.imgvr]
--pprmeta the PPR-Meta github [default: $params.pprmeta]
--meta the tsv dictionary w/ meta information about ViPhOG models [default: $params.meta]
Important! If you provide your own hmmer database follow this format:
rvdb/rvdb.hmm --> <folder>/<name>.hmm && 'folder' == 'name'
and provide the database following this command structure
--rvdb /path/to/your/rvdb
${c_yellow}Parameters:${c_reset}
--evalue E-value used to filter ViPhOG hits in the ratio_evalue step [default: $params.evalue]
--prop Minimum proportion of proteins with ViPhOG annotations to provide a taxonomic assignment [default: $params.prop]
--taxthres Minimum proportion of annotated genes required for taxonomic assignment [default: $params.taxthres]
--virome VirSorter parameter, set when running a data set mostly composed of viruses [default: $params.virome]
--hmmextend Use additional databases for more hmmscan results [default: $params.hmmextend]
--blastextend Use additional BLAST database (IMG/VR) for more annotation [default: $params.blastextend]
--chromomap WIP feature [default: $params.chromomap]
--length Initial length filter in kb [default: $params.length]
--sankey select the x taxa with highest count for sankey plot, try and error to change plot [default: $params.sankey]
--chunk WIP: chunk FASTA files into smaller pieces for parallel calculation [default: $params.chunk]
--onlyannotate Only annotate the input FASTA (no virus prediction, only contig length filtering) [default: $params.onlyannotate]
--mashmap Map the viral contigs against the provided reference ((fasta/fastq)[.gz]) with mashmap [default: $params.mashmap]
--mashmap_len Mashmap mapping segment length, shorter sequences will be ignored [default: $params.mashmap_len]
${c_yellow}Developing:${c_reset}
--viphog_version define the ViPhOG db version to be used [default: $params.viphog_version]
v1: no additional bit score filter (--cut_ga not applied, just e-value filtered)
v2: --cut_ga, min score used as sequence-specific GA, 3 bit trimmed for domain-specific GA
v3: --cut_ga, like v2 but seq-specific GA trimmed by 3 bits if second best score is 'nan'
--meta_version define the metadata table version to be used [default: $params.meta_version]
v1: older version of the meta data table using an outdated NCBI virus taxonomy, for reproducibility
v2: 2020 version of NCBI virus taxonomy
${c_dim}Nextflow options:
-with-report rep.html cpu / ram usage (may cause errors)
-with-dag chart.html generates a flowchart for the process tree
-with-timeline time.html timeline (may cause errors)
${c_yellow}HPC computing:${c_reset}
For execution of the workflow on a HPC (LSF, SLURM) adjust the following parameters if needed:
--databases defines the path where databases are stored [default: $params.dbs]
--workdir defines the path where nextflow writes tmp files [default: $params.workdir]
--cachedir defines the path where images (singularity) are cached [default: $params.cachedir]
${c_yellow}Profiles: Execution/Engine:${c_reset}
VIRify supports profiles to run via different ${c_green}Executers${c_reset} and ${c_blue}Engines${c_reset} e.g.:
-profile ${c_green}local${c_reset},${c_blue}docker${c_reset}
${c_green}Executer${c_reset} (choose one):
local
slurm
lsf
${c_blue}Engines${c_reset} (choose one):
docker
singularity
conda
Or use a ${c_yellow}pre-configured${c_reset} setup instead:
standard (local,docker) [default]
ebi (lsf,singularity; preconfigured for the EBI cluster)
yoda (lsf,singularity; preconfigured for the EBI YODA cluster)
nih (slurm,singularity; preconfigured for the NIH cluster)
gcloud (use this as template for your own GCP setup)
${c_reset}
""".stripIndent()
}