forked from nf-core/atacseq
-
Notifications
You must be signed in to change notification settings - Fork 0
/
main.nf
2258 lines (1955 loc) · 93.3 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
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env nextflow
/*
========================================================================================
nf-core/atacseq
========================================================================================
nf-core/atacseq Analysis Pipeline.
#### Homepage / Documentation
https://github.com/nf-core/atacseq
----------------------------------------------------------------------------------------
*/
def helpMessage() {
log.info nfcoreHeader()
log.info"""
Usage:
The typical command for running the pipeline is as follows:
nextflow run nf-core/atacseq --input design.csv --genome GRCh37 -profile docker
Mandatory arguments:
--input [file] Comma-separated file containing information about the samples in the experiment (see docs/usage.md) (Default: './design.csv')
--fasta [file] Path to Fasta reference. Not mandatory when using reference in iGenomes config via --genome (Default: false)
--gtf [file] Path to GTF file. Not mandatory when using reference in iGenomes config via --genome (Default: false)
-profile [str] Configuration profile to use. Can use multiple (comma separated)
Available: conda, docker, singularity, awsbatch, test
Generic
--single_end [bool] Specifies that the input is single-end reads (Default: false)
--seq_center [str] Sequencing center information to be added to read group of BAM files (Default: false)
--fragment_size [int] Estimated fragment size used to extend single-end reads (Default: 0)
--fingerprint_bins [int] Number of genomic bins to use when calculating fingerprint plot (Default: 500000)
References If not specified in the configuration file or you wish to overwrite any of the references
--genome [str] Name of iGenomes reference (Default: false)
--bwa_index [file] Full path to directory containing BWA index including base name i.e. /path/to/index/genome.fa (Default: false)
--gene_bed [file] Path to BED file containing gene intervals (Default: false)
--tss_bed [file] Path to BED file containing transcription start sites (Default: false)
--macs_gsize [str] Effective genome size parameter required by MACS2. If using iGenomes config, values have only been provided when --genome is set as GRCh37, GRCm38, hg19, mm10, BDGP6 and WBcel235 (Default: false)
--blacklist [file] Path to blacklist regions (.BED format), used for filtering alignments (Default: false)
--mito_name [str] Name of Mitochondrial chomosome in genome fasta (e.g. chrM). Reads aligning to this contig are filtered out (Default: false)
--save_reference [bool] If generated by the pipeline save the BWA index in the results directory (Default: false)
Trimming
--clip_r1 [int] Instructs Trim Galore to remove bp from the 5' end of read 1 (or single-end reads) (Default: 0)
--clip_r2 [int] Instructs Trim Galore to remove bp from the 5' end of read 2 (paired-end reads only) (Default: 0)
--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 (Default: 0)
--three_prime_clip_r2 [int] Instructs Trim Galore to remove bp from the 3' end of read 2 AFTER adapter/quality trimming has been performed (Default: 0)
--trim_nextseq [int] Instructs Trim Galore to apply the --nextseq=X option, to trim based on quality after removing poly-G tails (Default: 0)
--skip_trimming [bool] Skip the adapter trimming step (Default: false)
--save_trimmed [bool] Save the trimmed FastQ files in the results directory (Default: false)
Alignments
--bwa_min_score [int] Don’t output BWA MEM alignments with score lower than this parameter (Default: false)
--keep_mito [bool] Reads mapping to mitochondrial contig are not filtered from alignments (Default: false)
--keep_dups [bool] Duplicate reads are not filtered from alignments (Default: false)
--keep_multi_map [bool] Reads mapping to multiple locations are not filtered from alignments (Default: false)
--skip_merge_replicates [bool] Do not perform alignment merging and downstream analysis by merging replicates i.e. only do this by merging resequenced libraries (Default: false)
--save_align_intermeds [bool] Save the intermediate BAM files from the alignment step - not done by default (Default: false)
Peaks
--narrow_peak [bool] Run MACS2 in narrowPeak mode (Default: false)
--broad_cutoff [float] Specifies broad cutoff value for MACS2. Only used when --narrow_peak isnt specified (Default: 0.1)
--macs_fdr [float] Minimum FDR (q-value) cutoff for peak detection, --macs_fdr and --macs_pvalue are mutually exclusive (Default: false)
--macs_pvalue [float] p-value cutoff for peak detection, --macs_fdr and --macs_pvalue are mutually exclusive (Default: false)
--min_reps_consensus [int] Number of biological replicates required from a given condition for a peak to contribute to a consensus peak (Default: 1)
--save_macs_pileup [bool] Instruct MACS2 to create bedGraph files normalised to signal per million reads (Default: false)
--skip_peak_qc [bool] Skip MACS2 peak QC plot generation (Default: false)
--skip_peak_annotation [bool] Skip annotation of MACS2 and consensus peaks with HOMER (Default: false)
--skip_consensus_peaks [bool] Skip consensus peak generation (Default: false)
Differential analysis
--deseq2_vst [bool] Use vst transformation instead of rlog with DESeq2 (Default: false)
--skip_diff_analysis [bool] Skip differential accessibility analysis (Default: false)
QC
--skip_fastqc [bool] Skip FastQC (Default: false)
--skip_picard_metrics [bool] Skip Picard CollectMultipleMetrics (Default: false)
--skip_preseq [bool] Skip Preseq (Default: false)
--skip_plot_profile [bool] Skip deepTools plotProfile (Default: false)
--skip_plot_fingerprint [bool] Skip deepTools plotFingerprint (Default: false)
--skip_ataqv [bool] Skip Ataqv (Default: false)
--skip_igv [bool] Skip IGV (Default: false)
--skip_multiqc [bool] Skip MultiQC (Default: false)
Other
--outdir [file] The output directory where the results will be saved (Default: './results')
--publish_dir_mode [str] Mode for publishing results in the output directory. Available: symlink, rellink, link, copy, copyNoFollow, move (Default: copy)
--email [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 (Default: false)
--email_on_fail [email] Same as --email, except only send mail if the workflow is not successful (Default: false)
--max_multiqc_email_size [str] Threshold 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)
-name [str] Name for the pipeline run. If not specified, Nextflow will automatically generate a random mnemonic (Default: false)
AWSBatch
--awsqueue [str] The AWSBatch JobQueue that needs to be set when running on AWSBatch
--awsregion [str] The AWS Region for your AWS Batch job to run on
--awscli [str] Path to the AWS CLI tool
""".stripIndent()
}
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
/* -- -- */
/* -- SET UP CONFIGURATION VARIABLES -- */
/* -- -- */
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
// Show help message
if (params.help) {
helpMessage()
exit 0
}
// 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
}
////////////////////////////////////////////////////
/* -- DEFAULT PARAMETER VALUES -- */
////////////////////////////////////////////////////
// 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(", ")}"
}
// Configurable variables
params.fasta = params.genome ? params.genomes[ params.genome ].fasta ?: false : false
params.bwa_index = params.genome ? params.genomes[ params.genome ].bwa ?: false : false
params.gtf = params.genome ? params.genomes[ params.genome ].gtf ?: false : false
params.gene_bed = params.genome ? params.genomes[ params.genome ].bed12 ?: false : false
params.mito_name = params.genome ? params.genomes[ params.genome ].mito_name ?: false : false
params.macs_gsize = params.genome ? params.genomes[ params.genome ].macs_gsize ?: false : false
params.blacklist = params.genome ? params.genomes[ params.genome ].blacklist ?: false : false
params.anno_readme = params.genome ? params.genomes[ params.genome ].readme ?: false : false
// Global variables
def PEAK_TYPE = params.narrow_peak ? 'narrowPeak' : 'broadPeak'
////////////////////////////////////////////////////
/* -- CONFIG FILES -- */
////////////////////////////////////////////////////
// Pipeline config
ch_multiqc_config = file("$baseDir/assets/multiqc_config.yaml", checkIfExists: true)
ch_multiqc_custom_config = params.multiqc_config ? Channel.fromPath(params.multiqc_config, checkIfExists: true) : Channel.empty()
ch_output_docs = file("$baseDir/docs/output.md", checkIfExists: true)
ch_output_docs_images = file("$baseDir/docs/images/", checkIfExists: true)
// JSON files required by BAMTools for alignment filtering
if (params.single_end) {
ch_bamtools_filter_config = file(params.bamtools_filter_se_config, checkIfExists: true)
} else {
ch_bamtools_filter_config = file(params.bamtools_filter_pe_config, checkIfExists: true)
}
// Header files for MultiQC
ch_mlib_peak_count_header = file("$baseDir/assets/multiqc/mlib_peak_count_header.txt", checkIfExists: true)
ch_mlib_frip_score_header = file("$baseDir/assets/multiqc/mlib_frip_score_header.txt", checkIfExists: true)
ch_mlib_peak_annotation_header = file("$baseDir/assets/multiqc/mlib_peak_annotation_header.txt", checkIfExists: true)
ch_mlib_deseq2_pca_header = file("$baseDir/assets/multiqc/mlib_deseq2_pca_header.txt", checkIfExists: true)
ch_mlib_deseq2_clustering_header = file("$baseDir/assets/multiqc/mlib_deseq2_clustering_header.txt", checkIfExists: true)
ch_mrep_peak_count_header = file("$baseDir/assets/multiqc/mrep_peak_count_header.txt", checkIfExists: true)
ch_mrep_frip_score_header = file("$baseDir/assets/multiqc/mrep_frip_score_header.txt", checkIfExists: true)
ch_mrep_peak_annotation_header = file("$baseDir/assets/multiqc/mrep_peak_annotation_header.txt", checkIfExists: true)
ch_mrep_deseq2_pca_header = file("$baseDir/assets/multiqc/mrep_deseq2_pca_header.txt", checkIfExists: true)
ch_mrep_deseq2_clustering_header = file("$baseDir/assets/multiqc/mrep_deseq2_clustering_header.txt", checkIfExists: true)
////////////////////////////////////////////////////
/* -- VALIDATE INPUTS -- */
////////////////////////////////////////////////////
if (params.input) { ch_input = file(params.input, checkIfExists: true) } else { exit 1, 'Samples design file not specified!' }
if (params.gtf) { ch_gtf = file(params.gtf, checkIfExists: true) } else { exit 1, 'GTF annotation file not specified!' }
if (params.gene_bed) { ch_gene_bed = file(params.gene_bed, checkIfExists: true) }
if (params.tss_bed) { ch_tss_bed = file(params.tss_bed, checkIfExists: true) }
if (params.blacklist) { ch_blacklist = Channel.fromPath(params.blacklist, checkIfExists: true) } else { ch_blacklist = Channel.empty() }
if (params.fasta) {
lastPath = params.fasta.lastIndexOf(File.separator)
bwa_base = params.fasta.substring(lastPath+1)
ch_fasta = file(params.fasta, checkIfExists: true)
} else {
exit 1, 'Fasta file not specified!'
}
if (params.bwa_index) {
lastPath = params.bwa_index.lastIndexOf(File.separator)
bwa_dir = params.bwa_index.substring(0,lastPath+1)
bwa_base = params.bwa_index.substring(lastPath+1)
Channel
.fromPath(bwa_dir, checkIfExists: true)
.set { ch_bwa_index }
}
// Save AWS IGenomes file containing annotation version
if (params.anno_readme && file(params.anno_readme).exists()) {
file("${params.outdir}/genome/").mkdirs()
file(params.anno_readme).copyTo("${params.outdir}/genome/")
}
////////////////////////////////////////////////////
/* -- AWS -- */
////////////////////////////////////////////////////
if (workflow.profile.contains('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 (params.tracedir.startsWith('s3:')) exit 1, 'Specify a local tracedir or run without trace! S3 cannot be used for tracefiles.'
}
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
/* -- -- */
/* -- HEADER LOG INFO -- */
/* -- -- */
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
// Header log info
log.info nfcoreHeader()
def summary = [:]
summary['Run Name'] = custom_runName ?: workflow.runName
summary['Data Type'] = params.single_end ? 'Single-End' : 'Paired-End'
summary['Design File'] = params.input
summary['Genome'] = params.genome ?: 'Not supplied'
summary['Fasta File'] = params.fasta
summary['GTF File'] = params.gtf
if (params.gene_bed) summary['Gene BED File'] = params.gene_bed
if (params.tss_bed) summary['TSS BED File'] = params.tss_bed
if (params.bwa_index) summary['BWA Index'] = params.bwa_index
if (params.blacklist) summary['Blacklist BED'] = params.blacklist
if (params.mito_name) summary['Mitochondrial Contig'] = params.mito_name
if (params.bwa_min_score) summary['BWA Min Score'] = params.bwa_min_score
summary['MACS2 Genome Size'] = params.macs_gsize ?: 'Not supplied'
summary['Min Consensus Reps'] = params.min_reps_consensus
if (params.macs_gsize) summary['MACS2 Narrow Peaks'] = params.narrow_peak ? 'Yes' : 'No'
if (!params.narrow_peak) summary['MACS2 Broad Cutoff'] = params.broad_cutoff
if (params.macs_fdr) summary['MACS2 FDR'] = params.macs_fdr
if (params.macs_pvalue) summary['MACS2 P-value'] = params.macs_pvalue
if (params.skip_trimming) {
summary['Trimming Step'] = 'Skipped'
} else {
summary['Trim R1'] = "$params.clip_r1 bp"
summary['Trim R2'] = "$params.clip_r2 bp"
summary["Trim 3' R1"] = "$params.three_prime_clip_r1 bp"
summary["Trim 3' R2"] = "$params.three_prime_clip_r2 bp"
summary['NextSeq Trim'] = "$params.trim_nextseq bp"
}
if (params.seq_center) summary['Sequencing Center'] = params.seq_center
if (params.single_end) summary['Fragment Size'] = "$params.fragment_size bp"
summary['Fingerprint Bins'] = params.fingerprint_bins
if (params.keep_mito) summary['Keep Mitochondrial'] = 'Yes'
if (params.keep_dups) summary['Keep Duplicates'] = 'Yes'
if (params.keep_multi_map) summary['Keep Multi-mapped'] = 'Yes'
summary['Save Genome Index'] = params.save_reference ? 'Yes' : 'No'
if (params.save_trimmed) summary['Save Trimmed'] = 'Yes'
if (params.save_align_intermeds) summary['Save Intermeds'] = 'Yes'
if (params.save_macs_pileup) summary['Save MACS2 Pileup'] = 'Yes'
if (params.skip_merge_replicates) summary['Skip Merge Replicates'] = 'Yes'
if (params.skip_peak_qc) summary['Skip MACS2 Peak QC'] = 'Yes'
if (params.skip_peak_annotation) summary['Skip Peak Annotation'] = 'Yes'
if (params.skip_consensus_peaks) summary['Skip Consensus Peaks'] = 'Yes'
if (params.deseq2_vst) summary['Use DESeq2 vst Transform'] = 'Yes'
if (params.skip_diff_analysis) summary['Skip Differential Analysis'] = 'Yes'
if (params.skip_fastqc) summary['Skip FastQC'] = 'Yes'
if (params.skip_picard_metrics) summary['Skip Picard Metrics'] = 'Yes'
if (params.skip_preseq) summary['Skip Preseq'] = 'Yes'
if (params.skip_plot_profile) summary['Skip plotProfile'] = 'Yes'
if (params.skip_plot_fingerprint) summary['Skip plotFingerprint'] = 'Yes'
if (params.skip_ataqv) summary['Skip Ataqv'] = 'Yes'
if (params.skip_igv) summary['Skip IGV'] = 'Yes'
if (params.skip_multiqc) summary['Skip MultiQC'] = 'Yes'
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['Output Dir'] = params.outdir
summary['Launch Dir'] = workflow.launchDir
summary['Working Dir'] = workflow.workDir
summary['Script Dir'] = workflow.projectDir
summary['User'] = workflow.userName
if (workflow.profile.contains('awsbatch')) {
summary['AWS Region'] = params.awsregion
summary['AWS Queue'] = params.awsqueue
summary['AWS CLI'] = params.awscli
}
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 || params.email_on_fail) {
summary['E-mail Address'] = params.email
summary['E-mail on failure'] = params.email_on_fail
summary['MultiQC Max Size'] = params.max_multiqc_email_size
}
log.info summary.collect { k,v -> "${k.padRight(21)}: $v" }.join('\n')
log.info "-\033[2m--------------------------------------------------\033[0m-"
// Check the hostnames against configured profiles
checkHostname()
// Show a big warning message if we're not running MACS
if (!params.macs_gsize) {
def warnstring = params.genome ? "supported for '${params.genome}'" : 'supplied'
log.warn "=================================================================\n" +
" WARNING! MACS genome size parameter not $warnstring.\n" +
" Peak calling, annotation and differential analysis will be skipped.\n" +
" Please specify value for '--macs_gsize' to run these steps.\n" +
"======================================================================="
}
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
/* -- -- */
/* -- PARSE DESIGN FILE -- */
/* -- -- */
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
/*
* PREPROCESSING: Reformat design file and check validitiy
*/
process CHECK_DESIGN {
tag "$design"
publishDir "${params.outdir}/pipeline_info", mode: params.publish_dir_mode
input:
path design from ch_input
output:
path '*.csv' into ch_design_reads_csv
script: // This script is bundled with the pipeline, in nf-core/atacseq/bin/
"""
check_design.py $design design_reads.csv
"""
}
/*
* Create channels for input fastq files
*/
if (params.single_end) {
ch_design_reads_csv
.splitCsv(header:true, sep:',')
.map { row -> [ row.sample_id, [ file(row.fastq_1, checkIfExists: true) ] ] }
.into { ch_raw_reads_fastqc;
ch_raw_reads_trimgalore;
design_replicates_exist;
design_multiple_samples }
} else {
ch_design_reads_csv
.splitCsv(header:true, sep:',')
.map { row -> [ row.sample_id, [ file(row.fastq_1, checkIfExists: true), file(row.fastq_2, checkIfExists: true) ] ] }
.into { ch_raw_reads_fastqc;
ch_raw_reads_trimgalore;
design_replicates_exist;
design_multiple_samples }
}
// Boolean value for replicates existing in design
replicatesExist = design_replicates_exist
.map { it -> it[0].split('_')[-2].replaceAll('R','').toInteger() }
.flatten()
.max()
.val > 1
// Boolean value for multiple groups existing in design
multipleGroups = design_multiple_samples
.map { it -> it[0].split('_')[0..-3].join('_') }
.flatten()
.unique()
.count()
.val > 1
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
/* -- -- */
/* -- PREPARE ANNOTATION FILES -- */
/* -- -- */
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
/*
* PREPROCESSING: Build BWA index
*/
if (!params.bwa_index) {
process BWA_INDEX {
tag "$fasta"
label 'process_high'
publishDir path: { params.save_reference ? "${params.outdir}/genome" : params.outdir },
saveAs: { params.save_reference ? it : null }, mode: params.publish_dir_mode
input:
path fasta from ch_fasta
output:
path 'BWAIndex' into ch_bwa_index
script:
"""
bwa index -a bwtsw $fasta
mkdir BWAIndex && mv ${fasta}* BWAIndex
"""
}
}
/*
* PREPROCESSING: Generate gene BED file
*/
// If --gtf is supplied along with --genome
// Make gene bed from supplied --gtf instead of using iGenomes one automatically
def MAKE_BED = false
if (!params.gene_bed) {
MAKE_BED = true
} else if (params.genome && params.gtf) {
if (params.genomes[ params.genome ].gtf != params.gtf) {
MAKE_BED = true
}
}
if (MAKE_BED) {
process MAKE_GENE_BED {
tag "$gtf"
label 'process_low'
publishDir "${params.outdir}/genome", mode: params.publish_dir_mode
input:
path gtf from ch_gtf
output:
path '*.bed' into ch_gene_bed
script: // This script is bundled with the pipeline, in nf-core/atacseq/bin/
"""
gtf2bed $gtf > ${gtf.baseName}.bed
"""
}
}
/*
* PREPROCESSING: Generate TSS BED file
*/
if (!params.tss_bed) {
process MAKE_TSS_BED {
tag "$bed"
publishDir "${params.outdir}/genome", mode: params.publish_dir_mode
input:
path bed from ch_gene_bed
output:
path '*.bed' into ch_tss_bed
script:
"""
cat $bed | awk -v FS='\t' -v OFS='\t' '{ if(\$6=="+") \$3=\$2+1; else \$2=\$3-1; print \$1, \$2, \$3, \$4, \$5, \$6;}' > ${bed.baseName}.tss.bed
"""
}
}
/*
* PREPROCESSING: Prepare genome intervals for filtering
*/
process MAKE_GENOME_FILTER {
tag "$fasta"
publishDir "${params.outdir}/genome", mode: params.publish_dir_mode
input:
path fasta from ch_fasta
path blacklist from ch_blacklist.ifEmpty([])
output:
path "$fasta" // FASTA FILE FOR IGV
path '*.fai' // FAI INDEX FOR REFERENCE GENOME
path '*.bed' into ch_genome_filter_regions // BED FILE WITHOUT BLACKLIST REGIONS & MITOCHONDRIAL CONTIG FOR FILTERING
path '*.txt' into ch_genome_autosomes // TEXT FILE CONTAINING LISTING OF AUTOSOMAL CHROMOSOMES FOR ATAQV
path '*.sizes' into ch_genome_sizes_mlib_bigwig, // CHROMOSOME SIZES FILE FOR BEDTOOLS
ch_genome_sizes_mrep_bigwig
script:
blacklist_filter = params.blacklist ? "sortBed -i $blacklist -g ${fasta}.sizes | complementBed -i stdin -g ${fasta}.sizes" : "awk '{print \$1, '0' , \$2}' OFS='\t' ${fasta}.sizes"
name_filter = params.mito_name ? "| awk '\$1 !~ /${params.mito_name}/ {print \$0}'": ''
mito_filter = params.keep_mito ? '' : name_filter
"""
samtools faidx $fasta
get_autosomes.py ${fasta}.fai ${fasta}.autosomes.txt
cut -f 1,2 ${fasta}.fai > ${fasta}.sizes
$blacklist_filter $mito_filter > ${fasta}.include_regions.bed
"""
}
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
/* -- -- */
/* -- FASTQ QC -- */
/* -- -- */
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
/*
* STEP 1: FastQC
*/
process FASTQC {
tag "$name"
label 'process_medium'
publishDir "${params.outdir}/fastqc", mode: params.publish_dir_mode,
saveAs: { filename ->
filename.endsWith('.zip') ? "zips/$filename" : filename
}
when:
!params.skip_fastqc
input:
tuple val(name), path(reads) from ch_raw_reads_fastqc
output:
path '*.{zip,html}' into ch_fastqc_reports_mqc
script:
// Added soft-links to original fastqs for consistent naming in MultiQC
if (params.single_end) {
"""
[ ! -f ${name}.fastq.gz ] && ln -s $reads ${name}.fastq.gz
fastqc -q -t $task.cpus ${name}.fastq.gz
"""
} else {
"""
[ ! -f ${name}_1.fastq.gz ] && ln -s ${reads[0]} ${name}_1.fastq.gz
[ ! -f ${name}_2.fastq.gz ] && ln -s ${reads[1]} ${name}_2.fastq.gz
fastqc -q -t $task.cpus ${name}_1.fastq.gz
fastqc -q -t $task.cpus ${name}_2.fastq.gz
"""
}
}
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
/* -- -- */
/* -- ADAPTER TRIMMING -- */
/* -- -- */
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
/*
* STEP 2: Trim Galore!
*/
if (params.skip_trimming) {
ch_trimmed_reads = ch_raw_reads_trimgalore
ch_trimgalore_results_mqc = Channel.empty()
ch_trimgalore_fastqc_reports_mqc = Channel.empty()
} else {
process TRIMGALORE {
tag "$name"
label 'process_high'
publishDir "${params.outdir}/trim_galore", mode: params.publish_dir_mode,
saveAs: { filename ->
if (filename.endsWith('.html')) "fastqc/$filename"
else if (filename.endsWith('.zip')) "fastqc/zips/$filename"
else if (filename.endsWith('trimming_report.txt')) "logs/$filename"
else params.save_trimmed ? filename : null
}
input:
tuple val(name), path(reads) from ch_raw_reads_trimgalore
output:
tuple val(name), path('*.fq.gz') into ch_trimmed_reads
path '*.txt' into ch_trimgalore_results_mqc
path '*.{zip,html}' into ch_trimgalore_fastqc_reports_mqc
script:
// Calculate number of --cores for TrimGalore based on value of task.cpus
// See: https://github.com/FelixKrueger/TrimGalore/blob/master/Changelog.md#version-060-release-on-1-mar-2019
// See: https://github.com/nf-core/atacseq/pull/65
def cores = 1
if (task.cpus) {
cores = (task.cpus as int) - 4
if (params.single_end) cores = (task.cpus as int) - 3
if (cores < 1) cores = 1
if (cores > 4) cores = 4
}
// Added soft-links to original fastqs for consistent naming in MultiQC
c_r1 = params.clip_r1 > 0 ? "--clip_r1 ${params.clip_r1}" : ''
c_r2 = params.clip_r2 > 0 ? "--clip_r2 ${params.clip_r2}" : ''
tpc_r1 = params.three_prime_clip_r1 > 0 ? "--three_prime_clip_r1 ${params.three_prime_clip_r1}" : ''
tpc_r2 = params.three_prime_clip_r2 > 0 ? "--three_prime_clip_r2 ${params.three_prime_clip_r2}" : ''
nextseq = params.trim_nextseq > 0 ? "--nextseq ${params.trim_nextseq}" : ''
// Added soft-links to original fastqs for consistent naming in MultiQC
if (params.single_end) {
"""
[ ! -f ${name}.fastq.gz ] && ln -s $reads ${name}.fastq.gz
trim_galore --cores $cores --fastqc --gzip $c_r1 $tpc_r1 $nextseq ${name}.fastq.gz
"""
} else {
"""
[ ! -f ${name}_1.fastq.gz ] && ln -s ${reads[0]} ${name}_1.fastq.gz
[ ! -f ${name}_2.fastq.gz ] && ln -s ${reads[1]} ${name}_2.fastq.gz
trim_galore --cores $cores --paired --fastqc --gzip $c_r1 $c_r2 $tpc_r1 $tpc_r2 $nextseq ${name}_1.fastq.gz ${name}_2.fastq.gz
"""
}
}
}
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
/* -- -- */
/* -- ALIGN -- */
/* -- -- */
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
/*
* STEP 3.1: Map read(s) with bwa mem
*/
process BWA_MEM {
tag "$name"
label 'process_high'
input:
tuple val(name), path(reads) from ch_trimmed_reads
path index from ch_bwa_index.collect()
output:
tuple val(name), path('*.bam') into ch_bwa_bam
script:
prefix = "${name}.Lb"
rg = "\'@RG\\tID:${name}\\tSM:${name.split('_')[0..-2].join('_')}\\tPL:ILLUMINA\\tLB:${name}\\tPU:1\'"
if (params.seq_center) {
rg = "\'@RG\\tID:${name}\\tSM:${name.split('_')[0..-2].join('_')}\\tPL:ILLUMINA\\tLB:${name}\\tPU:1\\tCN:${params.seq_center}\'"
}
score = params.bwa_min_score ? "-T ${params.bwa_min_score}" : ''
"""
bwa mem \\
-t $task.cpus \\
-M \\
-R $rg \\
$score \\
${index}/${bwa_base} \\
$reads \\
| samtools view -@ $task.cpus -b -h -F 0x0100 -O BAM -o ${prefix}.bam -
"""
}
/*
* STEP 3.2: Convert BAM to coordinate sorted BAM
*/
process SORT_BAM {
tag "$name"
label 'process_medium'
if (params.save_align_intermeds) {
publishDir path: "${params.outdir}/bwa/library", mode: params.publish_dir_mode,
saveAs: { filename ->
if (filename.endsWith('.flagstat')) "samtools_stats/$filename"
else if (filename.endsWith('.idxstats')) "samtools_stats/$filename"
else if (filename.endsWith('.stats')) "samtools_stats/$filename"
else filename
}
}
input:
tuple val(name), path(bam) from ch_bwa_bam
output:
tuple val(name), path('*.sorted.{bam,bam.bai}') into ch_sort_bam_merge
path '*.{flagstat,idxstats,stats}' into ch_sort_bam_flagstat_mqc
script:
prefix = "${name}.Lb"
"""
samtools sort -@ $task.cpus -o ${prefix}.sorted.bam -T $name $bam
samtools index ${prefix}.sorted.bam
samtools flagstat ${prefix}.sorted.bam > ${prefix}.sorted.bam.flagstat
samtools idxstats ${prefix}.sorted.bam > ${prefix}.sorted.bam.idxstats
samtools stats ${prefix}.sorted.bam > ${prefix}.sorted.bam.stats
"""
}
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
/* -- -- */
/* -- MERGE LIBRARY BAM -- */
/* -- -- */
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
/*
* STEP 4.1: Merge BAM files for all libraries from same sample replicate
*/
ch_sort_bam_merge
.map { it -> [ it[0].split('_')[0..-2].join('_'), it[1] ] }
.groupTuple(by: [0])
.map { it -> [ it[0], it[1].flatten() ] }
.set { ch_sort_bam_merge }
process MERGED_LIB_BAM {
tag "$name"
label 'process_medium'
publishDir "${params.outdir}/bwa/mergedLibrary", mode: params.publish_dir_mode,
saveAs: { filename ->
if (filename.endsWith('.flagstat')) "samtools_stats/$filename"
else if (filename.endsWith('.idxstats')) "samtools_stats/$filename"
else if (filename.endsWith('.stats')) "samtools_stats/$filename"
else if (filename.endsWith('.metrics.txt')) "picard_metrics/$filename"
else params.save_align_intermeds ? filename : null
}
input:
tuple val(name), path(bams) from ch_sort_bam_merge
output:
tuple val(name), path("*${prefix}.sorted.{bam,bam.bai}") into ch_mlib_bam_filter,
ch_mlib_bam_preseq,
ch_mlib_bam_ataqv
path '*.{flagstat,idxstats,stats}' into ch_mlib_bam_stats_mqc
path '*.txt' into ch_mlib_bam_metrics_mqc
script:
prefix = "${name}.mLb.mkD"
bam_files = bams.findAll { it.toString().endsWith('.bam') }.sort()
def avail_mem = 3
if (!task.memory) {
log.info '[Picard MarkDuplicates] Available memory not known - defaulting to 3GB. Specify process memory requirements to change this.'
} else {
avail_mem = task.memory.toGiga()
}
if (bam_files.size() > 1) {
"""
picard -Xmx${avail_mem}g MergeSamFiles \\
${'INPUT='+bam_files.join(' INPUT=')} \\
OUTPUT=${name}.sorted.bam \\
SORT_ORDER=coordinate \\
VALIDATION_STRINGENCY=LENIENT \\
TMP_DIR=tmp
samtools index ${name}.sorted.bam
picard -Xmx${avail_mem}g MarkDuplicates \\
INPUT=${name}.sorted.bam \\
OUTPUT=${prefix}.sorted.bam \\
ASSUME_SORTED=true \\
REMOVE_DUPLICATES=false \\
METRICS_FILE=${prefix}.MarkDuplicates.metrics.txt \\
VALIDATION_STRINGENCY=LENIENT \\
TMP_DIR=tmp
samtools index ${prefix}.sorted.bam
samtools idxstats ${prefix}.sorted.bam > ${prefix}.sorted.bam.idxstats
samtools flagstat ${prefix}.sorted.bam > ${prefix}.sorted.bam.flagstat
samtools stats ${prefix}.sorted.bam > ${prefix}.sorted.bam.stats
"""
} else {
"""
picard -Xmx${avail_mem}g MarkDuplicates \\
INPUT=${bam_files[0]} \\
OUTPUT=${prefix}.sorted.bam \\
ASSUME_SORTED=true \\
REMOVE_DUPLICATES=false \\
METRICS_FILE=${prefix}.MarkDuplicates.metrics.txt \\
VALIDATION_STRINGENCY=LENIENT \\
TMP_DIR=tmp
samtools index ${prefix}.sorted.bam
samtools idxstats ${prefix}.sorted.bam > ${prefix}.sorted.bam.idxstats
samtools flagstat ${prefix}.sorted.bam > ${prefix}.sorted.bam.flagstat
samtools stats ${prefix}.sorted.bam > ${prefix}.sorted.bam.stats
"""
}
}
/*
* STEP 4.2: Filter BAM file at merged library-level
*/
process MERGED_LIB_BAM_FILTER {
tag "$name"
label 'process_medium'
publishDir path: "${params.outdir}/bwa/mergedLibrary", mode: params.publish_dir_mode,
saveAs: { filename ->
if (params.single_end || params.save_align_intermeds) {
if (filename.endsWith('.flagstat')) "samtools_stats/$filename"
else if (filename.endsWith('.idxstats')) "samtools_stats/$filename"
else if (filename.endsWith('.stats')) "samtools_stats/$filename"
else if (filename.endsWith('.sorted.bam')) filename
else if (filename.endsWith('.sorted.bam.bai')) filename
else null
}
}
input:
tuple val(name), path(bam) from ch_mlib_bam_filter
path bed from ch_genome_filter_regions.collect()
path bamtools_filter_config from ch_bamtools_filter_config
output:
tuple val(name), path('*.{bam,bam.bai}') into ch_mlib_filter_bam
tuple val(name), path('*.flagstat') into ch_mlib_filter_bam_flagstat
path '*.{idxstats,stats}' into ch_mlib_filter_bam_stats_mqc
script:
prefix = params.single_end ? "${name}.mLb.clN" : "${name}.mLb.flT"
filter_params = params.single_end ? '-F 0x004' : '-F 0x004 -F 0x0008 -f 0x001'
dup_params = params.keep_dups ? '' : '-F 0x0400'
multimap_params = params.keep_multi_map ? '' : '-q 1'
blacklist_params = params.blacklist ? "-L $bed" : ''
name_sort_bam = params.single_end ? '' : "samtools sort -n -@ $task.cpus -o ${prefix}.bam -T $prefix ${prefix}.sorted.bam"
"""
samtools view \\
$filter_params \\
$dup_params \\
$multimap_params \\
$blacklist_params \\
-b ${bam[0]} \\
| bamtools filter \\
-out ${prefix}.sorted.bam \\
-script $bamtools_filter_config
samtools index ${prefix}.sorted.bam
samtools flagstat ${prefix}.sorted.bam > ${prefix}.sorted.bam.flagstat
samtools idxstats ${prefix}.sorted.bam > ${prefix}.sorted.bam.idxstats
samtools stats ${prefix}.sorted.bam > ${prefix}.sorted.bam.stats
$name_sort_bam
"""
}
/*
* STEP 4.3: Remove orphan reads from paired-end BAM file
*/
if (params.single_end) {
ch_mlib_filter_bam
.into { ch_mlib_rm_orphan_bam_metrics;
ch_mlib_rm_orphan_bam_bigwig;
ch_mlib_rm_orphan_bam_macs;
ch_mlib_rm_orphan_bam_plotfingerprint;
ch_mlib_rm_orphan_bam_mrep;
ch_mlib_name_bam_mlib_counts;
ch_mlib_name_bam_mrep_counts }
ch_mlib_filter_bam_flagstat
.into { ch_mlib_rm_orphan_flagstat_bigwig;
ch_mlib_rm_orphan_flagstat_macs;
ch_mlib_rm_orphan_flagstat_mqc }
ch_mlib_filter_bam_stats_mqc
.set { ch_mlib_rm_orphan_stats_mqc }
} else {
process MERGED_LIB_BAM_REMOVE_ORPHAN {
tag "$name"
label 'process_medium'
publishDir path: "${params.outdir}/bwa/mergedLibrary", mode: params.publish_dir_mode,
saveAs: { filename ->
if (filename.endsWith('.flagstat')) "samtools_stats/$filename"
else if (filename.endsWith('.idxstats')) "samtools_stats/$filename"
else if (filename.endsWith('.stats')) "samtools_stats/$filename"
else if (filename.endsWith('.sorted.bam')) filename
else if (filename.endsWith('.sorted.bam.bai')) filename
else null
}
input:
tuple val(name), path(bam) from ch_mlib_filter_bam
output:
tuple val(name), path('*.sorted.{bam,bam.bai}') into ch_mlib_rm_orphan_bam_metrics,
ch_mlib_rm_orphan_bam_bigwig,
ch_mlib_rm_orphan_bam_macs,
ch_mlib_rm_orphan_bam_plotfingerprint,
ch_mlib_rm_orphan_bam_mrep
tuple val(name), path("${prefix}.bam") into ch_mlib_name_bam_mlib_counts,
ch_mlib_name_bam_mrep_counts
tuple val(name), path('*.flagstat') into ch_mlib_rm_orphan_flagstat_bigwig,
ch_mlib_rm_orphan_flagstat_macs,
ch_mlib_rm_orphan_flagstat_mqc
path '*.{idxstats,stats}' into ch_mlib_rm_orphan_stats_mqc
script: // This script is bundled with the pipeline, in nf-core/atacseq/bin/
prefix = "${name}.mLb.clN"
"""
bampe_rm_orphan.py ${bam[0]} ${prefix}.bam --only_fr_pairs
samtools sort -@ $task.cpus -o ${prefix}.sorted.bam -T $prefix ${prefix}.bam
samtools index ${prefix}.sorted.bam
samtools flagstat ${prefix}.sorted.bam > ${prefix}.sorted.bam.flagstat
samtools idxstats ${prefix}.sorted.bam > ${prefix}.sorted.bam.idxstats
samtools stats ${prefix}.sorted.bam > ${prefix}.sorted.bam.stats
"""
}
}
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
/* -- -- */
/* -- MERGE LIBRARY BAM POST-ANALYSIS -- */
/* -- -- */
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
/*
* STEP 5.1: Preseq analysis after merging libraries and before filtering
*/
process MERGED_LIB_PRESEQ {
tag "$name"
label 'process_low'
label 'error_ignore'
publishDir "${params.outdir}/bwa/mergedLibrary/preseq", mode: params.publish_dir_mode
when:
!params.skip_preseq
input:
tuple val(name), path(bam) from ch_mlib_bam_preseq
output:
path '*.ccurve.txt' into ch_mlib_preseq_mqc
path '*.log'
script:
prefix = "${name}.mLb.mkD"
pe = params.single_end ? '' : '-pe'
"""
preseq lc_extrap \\
-output ${prefix}.ccurve.txt \\
-verbose \\
-bam \\
$pe \\
-seed 1 \\
${bam[0]}
cp .command.err ${prefix}.command.log
"""
}
/*
* STEP 5.2: Picard CollectMultipleMetrics after merging libraries and filtering
*/
process MERGED_LIB_PICARD_METRICS {
tag "$name"
label 'process_medium'
publishDir path: "${params.outdir}/bwa/mergedLibrary", mode: params.publish_dir_mode,
saveAs: { filename ->
if (filename.endsWith('_metrics')) "picard_metrics/$filename"
else if (filename.endsWith('.pdf')) "picard_metrics/pdf/$filename"
else null
}
when:
!params.skip_picard_metrics
input:
tuple val(name), path(bam) from ch_mlib_rm_orphan_bam_metrics
path fasta from ch_fasta
output:
path '*_metrics' into ch_mlib_collectmetrics_mqc
path '*.pdf'
script:
prefix = "${name}.mLb.clN"
def avail_mem = 3
if (!task.memory) {
log.info '[Picard MarkDuplicates] Available memory not known - defaulting to 3GB. Specify process memory requirements to change this.'
} else {
avail_mem = task.memory.toGiga()
}
"""
picard -Xmx${avail_mem}g CollectMultipleMetrics \\
INPUT=${bam[0]} \\
OUTPUT=${prefix}.CollectMultipleMetrics \\
REFERENCE_SEQUENCE=$fasta \\
VALIDATION_STRINGENCY=LENIENT \\
TMP_DIR=tmp
"""
}
/*
* STEP 5.3: Read depth normalised bigWig
*/
process MERGED_LIB_BIGWIG {
tag "$name"
label 'process_medium'
publishDir "${params.outdir}/bwa/mergedLibrary/bigwig", mode: params.publish_dir_mode,
saveAs: { filename ->
if (filename.endsWith('scale_factor.txt')) "scale/$filename"
else if (filename.endsWith('.bigWig')) filename
else null
}
input:
tuple val(name), path(bam), path(flagstat) from ch_mlib_rm_orphan_bam_bigwig.join(ch_mlib_rm_orphan_flagstat_bigwig, by: [0])
path sizes from ch_genome_sizes_mlib_bigwig.collect()
output: