forked from nf-core/smrnaseq
-
Notifications
You must be signed in to change notification settings - Fork 0
/
main.nf
942 lines (800 loc) · 32.9 KB
/
main.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
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
#!/usr/bin/env nextflow
/*
========================================================================================
nf-core/smrnaseq
========================================================================================
nf-core/smrnaseq Analysis Pipeline.
#### Homepage / Documentation
https://github.com/nf-core/smrnaseq
----------------------------------------------------------------------------------------
*/
def helpMessage() {
log.info nfcoreHeader()
log.info"""
Usage:
The typical command for running the pipeline is as follows:
nextflow run nf-core/smrnaseq --reads '*.fastq.gz' --genome GRCh37 -profile docker
Mandatory arguments:
--reads Path to input data (must be surrounded with quotes).
NOTE! Paired-end data is NOT supported by this pipeline! For paired-end data, use Read 1 only
--genome Name of iGenomes reference. Not needed if --mature, --hairpin, --mirtrace_species are provided.
--protocol Library preparation protocol. Default: "illumina". Can be set as "illumina", "nextflex", "qiaseq" or "cats"
References
--saveReference Save the generated reference files the the Results directory
--mature Path to the FASTA file of mature miRNAs
--hairpin Path to the FASTA file of miRNA precursors
--mirna_gtf GFF/GTF file with coordinates positions of precursor and miRNAs. See: ftp://mirbase.org/pub/mirbase/CURRENT/genomes/hsa.gff3
--bt_index Path to the bowtie 1 index files of the host reference genome. Optional.
--mirtrace_species Species for miRTrace. Pre-defined when '--genome' is specified. (hsa, mmu ...)
Trimming options
--three_prime_adapter 3’ Adapter to trim. Default: None
--min_length [int] Discard reads that became shorter than length [int] because of either quality or adapter trimming. Default: 18
--clip_R1 [int] Instructs Trim Galore to remove bp from the 5' end of read 1
--three_prime_clip_R1 [int] Instructs Trim Galore to remove bp from the 3' end of read 1 AFTER adapter/quality trimming has been performed
QC
--skipQC Skip all QC steps aside from MultiQC
--skipFastqc Skip FastQC
--skipMultiqc Skip MultiQC
Other options
--outdir The output directory where the results will be saved
--email 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
-name Name for the pipeline run. If not specified, Nextflow will automatically generate a random mnemonic
--seq_center Text about sequencing center which will be added in the header of output bam files
--maxMultiqcEmailFileSize Theshold size for MultiQC report to be attached in notification email. If file generated by pipeline exceeds the threshold, it will not be attached (Default: 25MB)
AWSBatch options:
--awsqueue The AWSBatch JobQueue that needs to be set when running on AWSBatch
--awsregion The AWS Region for your AWS Batch job to run on
""".stripIndent()
}
/*
* SET UP CONFIGURATION VARIABLES
*/
// Show help message
if (params.help){
helpMessage()
exit 0
}
// Check if genome exists in the config file
if (params.genomes && params.genome && !params.genomes.containsKey(params.genome)) {
exit 1, "The provided genome '${params.genome}' is not available in the iGenomes file. Currently the available genomes are ${params.genomes.keySet().join(", ")}"
}
// Genome options
params.bt_index = params.genome ? params.genomes[ params.genome ].bowtie ?: false : false
params.bt_indices = null
params.mature = params.genome ? params.genomes[ params.genome ].mature ?: false : false
params.hairpin = params.genome ? params.genomes[ params.genome ].hairpin ?: false : false
params.mirtrace_species = params.genome ? params.genomes[ params.genome ].mirtrace_species ?: false : false
// Define regular variables so that they can be overwritten
clip_R1 = params.clip_R1
three_prime_clip_R1 = params.three_prime_clip_R1
three_prime_adapter = params.three_prime_adapter
protocol = params.protocol
// Presets
if (params.protocol == "illumina"){
clip_R1 = 0
three_prime_clip_R1 = 0
three_prime_adapter = "TGGAATTCTCGGGTGCCAAGG"
} else if (params.protocol == "nextflex"){
clip_R1 = 4
three_prime_clip_R1 = 4
three_prime_adapter = "TGGAATTCTCGGGTGCCAAGG"
} else if (params.protocol == "qiaseq"){
clip_R1 = 0
three_prime_clip_R1 = 0
three_prime_adapter = "AACTGTAGGCACCATCAAT"
} else if (params.protocol == "cats"){
clip_R1 = 3
three_prime_clip_R1 = 0
// three_prime_adapter = "GATCGGAAGAGCACACGTCTG"
three_prime_adapter = "AAAAAAAA"
} else {
//custom protocol
clip_R1 = params.clip_R1
three_prime_clip_R1 = params.three_prime_clip_R1
three_prime_adapter = params.three_prime_adapter
protocol = params.protocol
}
if (!params.mirna_gtf && params.mirtrace_species){
mirna_gtf = file("ftp://mirbase.org/pub/mirbase/CURRENT/genomes/${params.mirtrace_species}.gff3", checkIfExists: true)
}else if (params.mirna_gtf) {
mirna_gtf = file(params.mirna_gtf, checkIfExists: true)
}else{
mirna_gtf = false
}
// Validate inputs
if( !params.mature || !params.hairpin ){
exit 1, "Missing mature / hairpin reference indexes! Is --genome specified?"
}
if (params.mature) { mature = file(params.mature, checkIfExists: true) } else { exit 1, "Mature file not found: ${params.mature}" }
if (params.hairpin) { hairpin = file(params.hairpin, checkIfExists: true) } else { exit 1, "Hairpin file not found: ${params.hairpin}" }
if (params.gtf) { gtf = file(params.gtf, checkIfExists: true) }
if( params.bt_index ){
bt_indices = Channel
.fromPath("${params.bt_index}*", checkIfExists: true)
.ifEmpty { exit 1, "Bowtie1 index directory not found: ${bt_dir}" }
} else if( params.bt_indices ){
bt_indices = Channel.from(params.readPaths).map{ file(it) }.toList()
}
if( !params.bt_index) {
log.info "No GTF / Bowtie 1 index supplied - host reference genome analysis will be skipped."
}
if( !params.mirtrace_species ){
exit 1, "Reference species for miRTrace is not defined."
}
// Has the run name been specified by the user?
// this has the bonus effect of catching both -name and --name
custom_runName = params.name
if( !(workflow.runName ==~ /[a-z]+_[a-z]+/) ){
custom_runName = workflow.runName
}
if( workflow.profile == 'awsbatch') {
// AWSBatch sanity checking
if (!params.awsqueue || !params.awsregion) exit 1, "Specify correct --awsqueue and --awsregion parameters on AWSBatch!"
// Check outdir paths to be S3 buckets if running on AWSBatch
// related: https://github.com/nextflow-io/nextflow/issues/813
if (!params.outdir.startsWith('s3:')) exit 1, "Outdir not on S3 - specify S3 Bucket to run on AWSBatch!"
// Prevent trace files to be stored on S3 since S3 does not support rolling files.
if (workflow.tracedir.startsWith('s3:')) exit 1, "Specify a local tracedir or run without trace! S3 cannot be used for tracefiles."
}
// Stage config files
ch_multiqc_config = Channel.fromPath(params.multiqc_config, checkIfExists: true)
ch_output_docs = Channel.fromPath("$baseDir/docs/output.md", checkIfExists: true)
/*
* Create a channel for input read files
*/
if(params.readPaths){
Channel
.from(params.readPaths)
.map { file(it) }
.ifEmpty { exit 1, "params.readPaths was empty - no input files supplied" }
.into { raw_reads_fastqc; raw_reads_trimgalore; raw_reads_mirtrace }
} else {
Channel
.fromPath( params.reads )
.ifEmpty { exit 1, "Cannot find any reads matching: ${params.reads}" }
.into { raw_reads_fastqc; raw_reads_trimgalore; raw_reads_mirtrace }
}
// Header log info
log.info nfcoreHeader()
def summary = [:]
if(workflow.revision) summary['Pipeline Release'] = workflow.revision
summary['Run Name'] = custom_runName ?: workflow.runName
summary['Reads'] = params.reads
summary['Genome'] = params.genome
summary['Min Trimmed Length'] = params.min_length
summary["Trim 5' R1"] = clip_R1
summary["Trim 3' R1"] = three_prime_clip_R1
summary['miRBase mature'] = params.mature
summary['miRBase hairpin'] = params.hairpin
if(params.bt_index) summary['Bowtie Index for Ref'] = params.bt_index
summary['Save Reference'] = params.saveReference ? 'Yes' : 'No'
summary['Protocol'] = params.protocol
summary['miRTrace species'] = params.mirtrace_species
summary["3' adapter"] = three_prime_adapter
summary['Output dir'] = params.outdir
summary['Launch dir'] = workflow.launchDir
summary['Working dir'] = workflow.workDir
summary['Current home'] = "$HOME"
summary['Current user'] = "$USER"
summary['Current path'] = "$PWD"
summary['Script dir'] = workflow.projectDir
summary['Config Profile'] = (workflow.profile == 'standard' ? 'UPPMAX' : workflow.profile)
summary['Max Resources'] = "$params.max_memory memory, $params.max_cpus cpus, $params.max_time time per job"
if(workflow.containerEngine) summary['Container'] = "$workflow.containerEngine - $workflow.container"
summary['Script dir'] = workflow.projectDir
summary['User'] = workflow.userName
if(workflow.profile == 'awsbatch'){
summary['AWS Region'] = params.awsregion
summary['AWS Queue'] = params.awsqueue
}
summary['Config Profile'] = workflow.profile
if(params.config_profile_description) summary['Config Description'] = params.config_profile_description
if(params.config_profile_contact) summary['Config Contact'] = params.config_profile_contact
if(params.config_profile_url) summary['Config URL'] = params.config_profile_url
if(params.email) {
summary['E-mail Address'] = params.email
summary['MultiQC maxsize'] = params.maxMultiqcEmailFileSize
}
log.info summary.collect { k,v -> "${k.padRight(18)}: $v" }.join("\n")
log.info "\033[2m----------------------------------------------------\033[0m"
// Check the hostnames against configured profiles
checkHostname()
def create_workflow_summary(summary) {
def yaml_file = workDir.resolve('workflow_summary_mqc.yaml')
yaml_file.text = """
id: 'nf-core-smrnaseq-summary'
description: " - this information is collected when the pipeline is started."
section_name: 'nf-core/smrnaseq Workflow Summary'
section_href: 'https://github.com/nf-core/smrnaseq'
plot_type: 'html'
data: |
<dl class=\"dl-horizontal\">
${summary.collect { k,v -> " <dt>$k</dt><dd><samp>${v ?: '<span style=\"color:#999999;\">N/A</a>'}</samp></dd>" }.join("\n")}
</dl>
""".stripIndent()
return yaml_file
}
/*
* Parse software version numbers
*/
process get_software_versions {
publishDir "${params.outdir}/pipeline_info", mode: 'copy',
saveAs: {filename ->
if (filename.indexOf(".csv") > 0) filename
else null
}
output:
file 'software_versions_mqc.yaml' into software_versions_yaml
file "software_versions.csv"
script:
"""
echo $workflow.manifest.version > v_pipeline.txt
echo $workflow.nextflow.version > v_nextflow.txt
echo \$(R --version 2>&1) > v_R.txt
fastqc --version > v_fastqc.txt
trim_galore --version > v_trim_galore.txt
bowtie --version > v_bowtie.txt
samtools --version > v_samtools.txt
htseq-count -h > v_htseq.txt
fasta_formatter -h > v_fastx.txt
mirtrace --version > v_mirtrace.txt
multiqc --version > v_multiqc.txt
scrape_software_versions.py > software_versions_mqc.yaml
"""
}
/*
* PREPROCESSING - Build Bowtie index for mature and hairpin
*/
process make_bowtie_index {
label 'process_medium'
publishDir path: { params.saveReference ? "${params.outdir}/bowtie/reference" : params.outdir },
saveAs: { params.saveReference ? it : null }, mode: 'copy'
input:
file mature from mature
file hairpin from hairpin
output:
file 'mature_idx.*' into mature_index
file 'hairpin_idx.*' into hairpin_index
file 'hairpin_idx.fa' into hairpin_mirtop
script:
"""
seqkit grep -r --pattern \".*${params.mirtrace_species}-.*\" $mature > mature_sps.fa
seqkit seq --rna2dna mature_sps.fa > mature_igenome.fa
fasta_formatter -w 0 -i mature_igenome.fa -o mature_idx.fa
# fasta_nucleotide_changer -d -i mature_igenome.fa -o mature_idx.fa
bowtie-build mature_idx.fa mature_idx
seqkit grep -r --pattern \".*${params.mirtrace_species}-.*\" $hairpin > hairpin_sps.fa
seqkit seq --rna2dna hairpin_sps.fa > hairpin_igenome.fa
# fasta_nucleotide_changer -d -i hairpin_igenome.fa -o hairpin_idx.fa
fasta_formatter -w 0 -i hairpin_igenome.fa -o hairpin_idx.fa
bowtie-build hairpin_idx.fa hairpin_idx
"""
}
/*
* STEP 1 - FastQC
*/
process fastqc {
label 'process_low'
tag "$reads"
publishDir "${params.outdir}/fastqc", mode: 'copy'
when:
!params.skipQC && !params.skipFastqc
input:
file reads from raw_reads_fastqc
output:
file '*_fastqc.{zip,html}' into fastqc_results
script:
"""
fastqc -q $reads
"""
}
/*
* STEP 2 - Trim Galore!
*/
process trim_galore {
label 'process_low'
tag "$reads"
publishDir "${params.outdir}/trim_galore", mode: 'copy'
input:
file reads from raw_reads_trimgalore
output:
file '*.gz' into trimmed_reads_bowtie, trimmed_reads_collapse, trimmed_reads_bowtie_ref, trimmed_reads_insertsize
file '*trimming_report.txt' into trimgalore_results
file "*_fastqc.{zip,html}" into trimgalore_fastqc_reports
script:
tg_length = "--length ${params.min_length}"
c_r1 = clip_R1 > 0 ? "--clip_R1 ${clip_R1}" : ''
tpc_r1 = three_prime_clip_R1 > 0 ? "--three_prime_clip_R1 ${three_prime_clip_R1}" : ''
tpa = (protocol == "qiaseq" | protocol == "cats") ? "--adapter ${three_prime_adapter}" : '--small_rna'
"""
trim_galore --adapter ${three_prime_adapter} $tg_length $c_r1 $tpc_r1 --max_length 40 --gzip $reads --fastqc
"""
}
/*
* STEP 2.1 - Insertsize
*/
process insertsize {
label 'process_low'
tag "$reads"
publishDir "${params.outdir}/trim_galore/insertsize", mode: 'copy'
input:
file reads from trimmed_reads_insertsize
output:
file '*.insertsize' into insertsize_results
script:
prefix = reads.toString() - ~/(.R1)?(_R1)?(_trimmed)?(\.fq)?(\.fastq)?(\.gz)?$/
"""
awk 'NR%4 == 2 {lengths[length(\$0)]++} END {for (l in lengths) {print l, lengths[l]}}' <(zcat $reads) >${prefix}.insertsize
"""
}
/*
* STEP 2.2 - Collapse
*/
process collapse {
label 'process_medium'
tag "$reads"
input:
file reads from trimmed_reads_collapse
output:
file 'collapsed/*.fastq' into collapsed_fasta
script:
prefix = reads.toString() - '_trimmed.fq.gz'
"""
seqcluster collapse -f $reads -m 1 --min_size 15 -o collapsed
mv collapsed/${prefix}_trimmed_trimmed.fastq collapsed/${prefix}.fastq
"""
}
/*
* STEP 3 - Bowtie miRBase mature miRNA
*/
process bowtie_miRBase_mature {
label 'process_medium'
tag "$reads"
publishDir "${params.outdir}/bowtie/miRBase_mature", mode: 'copy', pattern: '*.mature_unmapped.fq.gz'
input:
file reads from trimmed_reads_bowtie
file index from mature_index
output:
file '*.mature.bam' into miRBase_mature_bam
file '*.mature_unmapped.fq.gz' into mature_unmapped_reads
script:
index_base = index.toString().tokenize(' ')[0].tokenize('.')[0]
prefix = reads.toString() - ~/(.R1)?(_R1)?(_trimmed)?(\.fq)?(\.fastq)?(\.gz)?$/
seq_center = params.seq_center ? "--sam-RG ID:${prefix} --sam-RG 'CN:${params.seq_center}'" : ''
"""
bowtie \\
$index_base \\
-q <(zcat $reads) \\
-p ${task.cpus} \\
-t \\
-k 50 \\
--best \\
--strata \\
-e 99999 \\
--chunkmbs 2048 \\
--un ${prefix}.mature_unmapped.fq \\
-S $seq_center \\
| samtools view -bS - > ${prefix}.mature.bam
gzip ${prefix}.mature_unmapped.fq
"""
}
/*
* STEP 4 - Bowtie against miRBase hairpin
*/
process bowtie_miRBase_hairpin {
label 'process_medium'
tag "$reads"
publishDir "${params.outdir}/bowtie/miRBase_hairpin", mode: 'copy', pattern: '*.hairpin_unmapped.fq.gz'
input:
file reads from mature_unmapped_reads
file index from hairpin_index
output:
file '*.hairpin.bam' into miRBase_hairpin_bam, miRBase_hairpin_bam_mirtop
file '*.hairpin_unmapped.fq.gz' into hairpin_unmapped_reads
script:
index_base = index.toString().tokenize(' ')[0].tokenize('.')[0]
prefix = reads.toString() - '.mature_unmapped.fq.gz'
seq_center = params.seq_center ? "--sam-RG ID:${prefix} --sam-RG 'CN:${params.seq_center}'" : ''
"""
bowtie \\
$index_base \\
-p ${task.cpus} \\
-t \\
-a \\
--best \\
--strata \\
-e 99999 \\
--chunkmbs 2048 \\
-q <(zcat $reads) \\
--un ${prefix}.hairpin_unmapped.fq \\
-S $seq_center \\
| samtools view -bS - > ${prefix}.hairpin.bam
gzip ${prefix}.hairpin_unmapped.fq
"""
}
/*
* STEP 4.1 - Bowtie against miRBase hairpin with collapsed reads
*/
process bowtie_miRBase_hairpin_collapsed {
label 'process_medium'
tag "$reads"
input:
file reads from collapsed_fasta
file index from hairpin_index
output:
file '*.bam' into miRBase_hairpin_collapse_bam
script:
index_base = index.toString().tokenize(' ')[0].tokenize('.')[0]
prefix = reads.baseName
seq_center = params.seq_center ? "--sam-RG ID:${prefix} --sam-RG 'CN:${params.seq_center}'" : ''
"""
bowtie \\
$index_base \\
-p ${task.cpus} \\
-t \\
-k 50 \\
-a \\
--best \\
--strata \\
-e 99999 \\
--chunkmbs 2048 \\
-q <(cat $reads) \\
-S $seq_center \\
| samtools view -bS - > ${prefix}.bam
"""
}
/*
* STEP 5.1 - Post-alignment processing for miRBase mature and hairpin
*/
def wrap_mature_and_hairpin = { file ->
if ( file.contains("mature") ) return "miRBase_mature/$file"
if ( file.contains("hairpin") ) return "miRBase_hairpin/$file"
}
process mirna_post_alignment {
label 'process_medium'
tag "$input"
publishDir "${params.outdir}/bowtie", mode: 'copy', saveAs: wrap_mature_and_hairpin
input:
file input from miRBase_mature_bam.mix(miRBase_hairpin_bam)
output:
file "${input.baseName}.stats" into miRBase_counts
file "*.{flagstat,idxstats,stats}" into ch_sort_bam_flagstat_mqc
file "${input.baseName}.sorted.bam" into miRBase_bam
file "${input.baseName}.sorted.bam.bai" into miRBase_bai
script:
"""
samtools sort ${input.baseName}.bam -o ${input.baseName}.sorted.bam
samtools index ${input.baseName}.sorted.bam
samtools idxstats ${input.baseName}.sorted.bam > ${input.baseName}.stats
samtools flagstat ${input.baseName}.sorted.bam > ${input.baseName}.sorted.bam.flagstat
samtools stats ${input.baseName}.sorted.bam > ${input.baseName}.sorted.bam.stats
"""
}
/*
* STEP 5.2 - edgeR miRBase feature counts processing
*/
process edgeR_mirna {
label 'process_low'
label 'process_ignore'
publishDir "${params.outdir}/edgeR", mode: 'copy', saveAs: wrap_mature_and_hairpin
input:
file input_files from miRBase_counts.toSortedList()
output:
file '*.{txt,pdf}' into edgeR_miRBase_results
script:
"""
edgeR_miRBase.r $input_files
"""
}
/*
* STEP 5.3 - miRNA format conversion to mirGFF3
*/
process mirtop_bam_hairpin {
label 'process_medium'
tag "$input"
publishDir "${params.outdir}", mode: 'copy'
when:
mirna_gtf
input:
file input from miRBase_hairpin_collapse_bam.collect()
file hairpin from hairpin_mirtop
file gtf from mirna_gtf
output:
file "mirtop/mirtop.gff" into mirtop_gff
file "mirtop/mirtop.tsv" into mirtop_tsv
file "mirtop/mirna.tsv" into mirna_tsv
file "mirtop/mirtop_rawData.tsv" into isomir_tsv
script:
"""
mirtop gff --hairpin $hairpin --gtf $gtf -o mirtop --sps $params.mirtrace_species $input
mirtop counts --hairpin $hairpin --gtf $gtf -o mirtop --sps $params.mirtrace_species --add-extra --gff mirtop/mirtop.gff
mirtop export --format isomir --hairpin $hairpin --gtf $gtf --sps $params.mirtrace_species -o mirtop mirtop/mirtop.gff
collapse_mirtop.r mirtop/mirtop.tsv
"""
}
/*
* STEP 6.1 and 6.2 IF A GENOME SPECIFIED ONLY!
*/
if( params.bt_index ) {
/*
* STEP 6.1 - Bowtie 1 against reference genome
*/
process bowtie_ref {
label 'process_high'
tag "$reads"
publishDir "${params.outdir}/bowtie_ref", mode: 'copy'
input:
file reads from trimmed_reads_bowtie_ref
file indices from bt_indices.collect()
output:
file '*.genome.bam' into bowtie_bam, bowtie_bam_for_unmapped
script:
index_base = indices[0].toString() - ~/.rev.\d.ebwt?/ - ~/.\d.ebwt?/
prefix = reads.toString() - ~/(.R1)?(_R1)?(_trimmed)?(\.fq)?(\.fastq)?(\.gz)?$/
seq_center = params.seq_center ? "--sam-RG ID:${prefix} --sam-RG 'CN:${params.seq_center}'" : ''
"""
bowtie \\
$index_base \\
-q <(zcat $reads) \\
-p ${task.cpus} \\
-t \\
-k 50 \\
--best \\
--strata \\
-e 99999 \\
--chunkmbs 2048 \\
-S $seq_center \\
| samtools view -bS - > ${prefix}.genome.bam
"""
}
process genome_post_alignment {
label 'process_low'
tag "$input"
publishDir "${params.outdir}/bowtie_ref", mode: 'copy'
input:
file input from bowtie_bam
output:
file "*.{flagstat,idxstats,stats}" into ch_genome_bam_flagstat_mqc
script:
"""
samtools sort ${input.baseName}.bam -o ${input.baseName}.sorted.bam
samtools index ${input.baseName}.sorted.bam
samtools idxstats ${input.baseName}.sorted.bam > ${input.baseName}.stats
samtools flagstat ${input.baseName}.sorted.bam > ${input.baseName}.sorted.bam.flagstat
samtools stats ${input.baseName}.sorted.bam > ${input.baseName}.sorted.bam.stats
"""
}
/*
* STEP 6.2 - Statistics about unmapped reads against ref genome
*/
process bowtie_unmapped {
label 'process_ignore'
label 'process_medium'
tag "${input_files[0].baseName}"
publishDir "${params.outdir}/bowtie_ref/unmapped", mode: 'copy'
input:
file input_files from bowtie_bam_for_unmapped.toSortedList()
output:
file 'unmapped_refgenome.txt' into bowtie_unmapped
script:
"""
for i in $input_files
do
printf "\${i}\t"
samtools view -c -f0x4 \${i}
done > unmapped_refgenome.txt
"""
}
} else{
ch_genome_bam_flagstat_mqc = Channel.empty()
}
/*
* STEP 7 - miRTrace
*/
process mirtrace {
tag "$reads"
publishDir "${params.outdir}/miRTrace", mode: 'copy'
input:
file reads from raw_reads_mirtrace.collect()
output:
file '*mirtrace' into mirtrace_results
script:
primer = (protocol=="cats") ? " " : " --adapter $three_prime_adapter "
"""
for i in $reads
do
path=\$(realpath \${i})
prefix=\$(echo \${i} | sed -e "s/.gz//" -e "s/.fastq//" -e "s/.fq//" -e "s/_val_1//" -e "s/_trimmed//" -e "s/_R1//" -e "s/.R1//")
echo \$path","\$prefix
done > mirtrace_config
mirtrace qc \\
--species $params.mirtrace_species \\
$primer \\
--protocol $protocol \\
--config mirtrace_config \\
--write-fasta \\
--output-dir mirtrace \\
--force
"""
}
/*
* STEP 8 - MultiQC
*/
process multiqc {
publishDir "${params.outdir}/MultiQC", mode: 'copy'
when:
!params.skipQC && !params.skipMultiqc
input:
file multiqc_config from ch_multiqc_config
file ('fastqc/*') from fastqc_results.collect()
file ('trim_galore/*') from trimgalore_results.collect()
file ('mirtrace/*') from mirtrace_results.collect()
file ('samtools/*') from ch_sort_bam_flagstat_mqc.collect()
file ('samtools_genome/*') from ch_genome_bam_flagstat_mqc.collect().ifEmpty([])
file ('software_versions/*') from software_versions_yaml.collect()
file workflow_summary from create_workflow_summary(summary)
output:
file "*multiqc_report.html" into multiqc_report
file "*_data"
script:
rtitle = custom_runName ? "--title \"$custom_runName\"" : ''
rfilename = custom_runName ? "--filename " + custom_runName.replaceAll('\\W','_').replaceAll('_+','_') + "_multiqc_report" : ''
"""
multiqc . -f $rtitle $rfilename --config $multiqc_config -m bowtie1 -m samtools -m cutadapt -m fastqc -m custom_content
"""
}
/*
* STEP 9 - Output Description HTML
*/
process output_documentation {
publishDir "${params.outdir}/pipeline_info", mode: 'copy'
input:
file output_docs from ch_output_docs
output:
file "results_description.html"
script:
"""
markdown_to_html.r $output_docs results_description.html
"""
}
/*
* Completion e-mail notification
*/
workflow.onComplete {
// Set up the e-mail variables
def subject = "[nf-core/smrnaseq] Successful: $workflow.runName"
if(!workflow.success){
subject = "[nf-core/smrnaseq] FAILED: $workflow.runName"
}
def email_fields = [:]
email_fields['version'] = workflow.manifest.version
email_fields['runName'] = custom_runName ?: workflow.runName
email_fields['success'] = workflow.success
email_fields['dateComplete'] = workflow.complete
email_fields['duration'] = workflow.duration
email_fields['exitStatus'] = workflow.exitStatus
email_fields['errorMessage'] = (workflow.errorMessage ?: 'None')
email_fields['errorReport'] = (workflow.errorReport ?: 'None')
email_fields['commandLine'] = workflow.commandLine
email_fields['projectDir'] = workflow.projectDir
email_fields['summary'] = summary
email_fields['summary']['Date Started'] = workflow.start
email_fields['summary']['Date Completed'] = workflow.complete
email_fields['summary']['Pipeline script file path'] = workflow.scriptFile
email_fields['summary']['Pipeline script hash ID'] = workflow.scriptId
if(workflow.repository) email_fields['summary']['Pipeline repository Git URL'] = workflow.repository
if(workflow.commitId) email_fields['summary']['Pipeline repository Git Commit'] = workflow.commitId
if(workflow.revision) email_fields['summary']['Pipeline Git branch/tag'] = workflow.revision
if(workflow.container) email_fields['summary']['Docker image'] = workflow.container
email_fields['summary']['Nextflow Version'] = workflow.nextflow.version
email_fields['summary']['Nextflow Build'] = workflow.nextflow.build
email_fields['summary']['Nextflow Compile Timestamp'] = workflow.nextflow.timestamp
// On success try attach the multiqc report
def mqc_report = null
try {
if (workflow.success) {
mqc_report = multiqc_report.getVal()
if (mqc_report.getClass() == ArrayList){
log.warn "[nf-core/smrnaseq] Found multiple reports from process 'multiqc', will use only one"
mqc_report = mqc_report[0]
}
}
} catch (all) {
log.warn "[nf-core/smrnaseq] Could not attach MultiQC report to summary email"
}
// Render the TXT template
def engine = new groovy.text.GStringTemplateEngine()
def tf = new File("$baseDir/assets/email_template.txt")
def txt_template = engine.createTemplate(tf).make(email_fields)
def email_txt = txt_template.toString()
// Render the HTML template
def hf = new File("$baseDir/assets/email_template.html")
def html_template = engine.createTemplate(hf).make(email_fields)
def email_html = html_template.toString()
// Render the sendmail template
def smail_fields = [ email: params.email, subject: subject, email_txt: email_txt, email_html: email_html, baseDir: "$baseDir", mqcFile: mqc_report, mqcMaxSize: params.maxMultiqcEmailFileSize.toBytes() ]
def sf = new File("$baseDir/assets/sendmail_template.txt")
def sendmail_template = engine.createTemplate(sf).make(smail_fields)
def sendmail_html = sendmail_template.toString()
// Send the HTML e-mail
if (params.email) {
try {
if( params.plaintext_email ){ throw GroovyException('Send plaintext e-mail, not HTML') }
// Try to send HTML e-mail using sendmail
[ 'sendmail', '-t' ].execute() << sendmail_html
log.info "[nf-core/smrnaseq] Sent summary e-mail to $params.email (sendmail)"
} catch (all) {
// Catch failures and try with plaintext
[ 'mail', '-s', subject, params.email ].execute() << email_txt
log.info "[nf-core/smrnaseq] Sent summary e-mail to $params.email (mail)"
}
}
// Switch the embedded MIME images with base64 encoded src
smrnaseqlogo = new File("$baseDir/assets/smrnaseq_logo.png").bytes.encodeBase64().toString()
email_html = email_html.replaceAll(~/cid:smrnaseqlogo/, "data:image/png;base64,$smrnaseqlogo")
// Write summary e-mail HTML to a file
def output_d = new File( "${params.outdir}/pipeline_info/" )
if( !output_d.exists() ) {
output_d.mkdirs()
}
def output_hf = new File( output_d, "pipeline_report.html" )
output_hf.withWriter { w -> w << email_html }
def output_tf = new File( output_d, "pipeline_report.txt" )
output_tf.withWriter { w -> w << email_txt }
c_reset = params.monochrome_logs ? '' : "\033[0m";
c_purple = params.monochrome_logs ? '' : "\033[0;35m";
c_green = params.monochrome_logs ? '' : "\033[0;32m";
c_red = params.monochrome_logs ? '' : "\033[0;31m";
if (workflow.stats.ignoredCount > 0 && workflow.success) {
log.info "${c_purple}Warning, pipeline completed, but with errored process(es) ${c_reset}"
log.info "${c_red}Number of ignored errored process(es) : ${workflow.stats.ignoredCount} ${c_reset}"
log.info "${c_green}Number of successfully ran process(es) : ${workflow.stats.succeedCount} ${c_reset}"
}
if(workflow.success){
log.info "${c_purple}[nf-core/smrnaseq]${c_green} Pipeline completed successfully${c_reset}"
} else {
checkHostname()
log.info "${c_purple}[nf-core/smrnaseq]${c_red} Pipeline completed with errors${c_reset}"
}
}
def nfcoreHeader(){
// Log colors ANSI codes
c_reset = params.monochrome_logs ? '' : "\033[0m";
c_dim = params.monochrome_logs ? '' : "\033[2m";
c_black = params.monochrome_logs ? '' : "\033[0;30m";
c_green = params.monochrome_logs ? '' : "\033[0;32m";
c_yellow = params.monochrome_logs ? '' : "\033[0;33m";
c_blue = params.monochrome_logs ? '' : "\033[0;34m";
c_purple = params.monochrome_logs ? '' : "\033[0;35m";
c_cyan = params.monochrome_logs ? '' : "\033[0;36m";
c_white = params.monochrome_logs ? '' : "\033[0;37m";
return """ ${c_dim}----------------------------------------------------${c_reset}
${c_green},--.${c_black}/${c_green},-.${c_reset}
${c_blue} ___ __ __ __ ___ ${c_green}/,-._.--~\'${c_reset}
${c_blue} |\\ | |__ __ / ` / \\ |__) |__ ${c_yellow}} {${c_reset}
${c_blue} | \\| | \\__, \\__/ | \\ |___ ${c_green}\\`-._,-`-,${c_reset}
${c_green}`._,._,\'${c_reset}
${c_purple} nf-core/smrnaseq v${workflow.manifest.version}${c_reset}
${c_dim}----------------------------------------------------${c_reset}
""".stripIndent()
}
def checkHostname(){
def c_reset = params.monochrome_logs ? '' : "\033[0m"
def c_white = params.monochrome_logs ? '' : "\033[0;37m"
def c_red = params.monochrome_logs ? '' : "\033[1;91m"
def c_yellow_bold = params.monochrome_logs ? '' : "\033[1;93m"
if(params.hostnames){
def hostname = "hostname".execute().text.trim()
params.hostnames.each { prof, hnames ->
hnames.each { hname ->
if(hostname.contains(hname) && !workflow.profile.contains(prof)){
log.error "====================================================\n" +
" ${c_red}WARNING!${c_reset} You are running with `-profile $workflow.profile`\n" +
" but your machine hostname is ${c_white}'$hostname'${c_reset}\n" +
" ${c_yellow_bold}It's highly recommended that you use `-profile $prof${c_reset}`\n" +
"============================================================"
}
}
}
}
}