Pinch docs and delete redundant modules

This commit is contained in:
drpatelh 2020-08-05 17:24:40 +01:00
parent 5d224740cd
commit 1edc58a36b
16 changed files with 0 additions and 451 deletions

View file

@ -1,18 +0,0 @@
process samtools_index {
tag "${bam.baseName}"
container 'quay.io/biocontainers/samtools:1.9--h10a08f8_12'
input:
path bam
output:
path "*.bam.bai"
script:
"""
samtools index $bam
samtools --version &> v_samtools.txt
"""
}

View file

@ -1,27 +0,0 @@
name: samtools sort
description: Sort a BAM or CRAM file
keywords:
- sort
tools:
- samtools:
description: |
SAMtools is a set of utilities for interacting with and post-processing
short DNA sequence read alignments in the SAM, BAM and CRAM formats, written by Heng Li.
These files are generated as output by short read aligners like BWA.
homepage: http://www.htslib.org/
documentation: hhttp://www.htslib.org/doc/samtools.html
doi: 10.1093/bioinformatics/btp352
input:
-
- input:
type: file
description: Input BAM or CRAM file
pattern: "*.{bam,cram}"
output:
-
- sorted_file:
type: file
description: Sorted BAM or CRAM file
pattern: "*.{bam,cram}"
authors:
- "@ewels"

View file

@ -1,13 +0,0 @@
#!/usr/bin/env nextflow
echo true
cheers = Channel.from 'Bonjour', 'Ciao', 'Hello', 'Hola'
process sayHello {
input:
val x from cheers
script:
"""
echo '$x world!'
"""
}

View file

@ -1,2 +0,0 @@
docker.enabled = true
params.outdir = './results'

View file

@ -1,10 +0,0 @@
FROM nfcore/base:1.7
LABEL authors="phil.ewels@scilifelab.se" \
description="Docker image for nf-core modules trimgalore"
#### THIS IS A BUG
# foobar
COPY environment.yml /
RUN conda env create -f /environment.yml && conda clean -a
ENV PATH /opt/conda/envs/nf-core-modules-trimgalore/bin:$PATH

View file

@ -1,9 +0,0 @@
# You can use this file to create a conda environment for this pipeline:
# conda env create -f environment.yml
name: nf-core-modules-trimgalore
channels:
- conda-forge
- bioconda
- defaults
dependencies:
- trim-galore=0.6.4

View file

@ -1,102 +0,0 @@
nextflow.preview.dsl=2
params.singlecell = ''
params.rrbs = ''
params.pbat = ''
params.single_end = false
params.trim_nextseq = 0
params.clip_r1 = 0
params.clip_r2 = 0
params.three_prime_clip_r1 = 0
params.three_prime_clip_r2 = 0
process TRIM_GALORE {
// container 'quay.io/biocontainers/trim-galore:0.6.5--0' // maybe later
// tag "$sample_id"
// Trimming reports are not generated for e.g. --hardtrim5, --clock etc
// saveAs: {filename ->
// else if (filename.indexOf("trimming_report.txt") > 0) "logs/$filename"
// else filename
// }
publishDir "${outdir}/trim_galore",
mode: "copy", overwrite: true
input:
tuple val(name), path(reads)
val outdir
val trim_galore_args
val verbose
output:
tuple val(name), path ("*fq.gz"), emit: reads
path "*trimming_report.txt", optional: true, emit: report
script:
if (verbose){
println ("[MODULE] TRIM GALORE ARGS: " + trim_galore_args)
}
trim_galore_args += " --gzip " // we like small files
pairedString = 0
if (reads instanceof List) {
pairedString = 1
trim_galore_args += " --paired "
}
if (params.clip_r1 > 0){
trim_galore_args += " --clip_r1 ${params.clip_r1} "
}
if (params.clip_r2 > 0){
trim_galore_args += " --clip_r2 ${params.clip_r2} "
}
if (params.three_prime_clip_r1> 0){
trim_galore_args += " --three_prime_clip_r1 ${params.three_prime_clip_r1} "
}
if (params.three_prime_clip_r2 > 0){
trim_galore_args += " --three_prime_clip_r2 ${params.three_prime_clip_r2} "
}
if (params.trim_nextseq > 0){
trim_galore_args += " --nextseq ${params.trim_nextseq} "
}
// Pre-set parameters for certain bisulfite-seq applications
if (params.singlecell){
trim_galore_args += " --clip_r1 6 "
if (pairedString == 1){
trim_galore_args += " --clip_r2 6 "
}
}
if (params.rrbs){
trim_galore_args += " --rrbs "
}
if (params.pbat){
trim_galore_args += " --clip_r1 $params.pbat "
if (pairedString == 1){
trim_galore_args += " --clip_r2 $params.pbat "
}
}
"""
module load trim_galore
trim_galore $trim_galore_args $reads
"""
}

View file

@ -1,40 +0,0 @@
name: Trim Galore!
description: Trim FastQ files using Trim Galore!
keywords:
- trimming
- adapters
- sequencing adapters
tools:
- fastqc:
description: |
A wrapper tool around Cutadapt and FastQC to consistently apply quality
and adapter trimming to FastQ files, with some extra functionality for
MspI-digested RRBS-type (Reduced Representation Bisufite-Seq) libraries.
homepage: https://www.bioinformatics.babraham.ac.uk/projects/trim_galore/
documentation: https://github.com/FelixKrueger/TrimGalore/blob/master/Docs/Trim_Galore_User_Guide.md
input:
-
- sample_id:
type: string
description: Sample identifier
- reads:
type: file
description: Input FastQ file, or pair of files
output:
-
- sample_id:
type: string
description: Sample identifier
- trimmed_fastq:
type: file
description: Trimmed FastQ files
pattern: "*fq.gz"
-
- report:
type: file
description: Trim Galore! trimming report
pattern: "*trimming_report.txt"
authors:
- "@ewels"
- "@FelixKrueger"

View file

@ -1 +0,0 @@
../../../../tests/data/fastq/rna/test_R1.fastq.gz

View file

@ -1 +0,0 @@
../../../../tests/data/fastq/rna/test_R2.fastq.gz

View file

@ -1,27 +0,0 @@
#!/usr/bin/env nextflow
nextflow.preview.dsl=2
params.outdir = "." // gets set in the nextflow.config files (to './results/trim_galore')
params.verbose = false
params.trim_galore_args = ''
// trim_galore_args are best passed into the workflow in the following manner, e.g.:
// --trim_galore_args="--clip_r1 10 --clip_r2 15 -j 2"
if (params.verbose){
println ("[WORKFLOW] TRIM GALORE ARGS: " + params.trim_galore_args)
}
// TODO: check the output files in some way
// include '../../../tests/functions/check_process_outputs.nf'
include '../main.nf' // params (clip_r1: 6, clip_r2: 10) // how to pass additional parameters
ch_read_files = Channel
.fromFilePairs('../../../test-datasets/test*{1,2}.fastq.gz',size:-1)
// .view() // to check whether the input channel works
workflow {
main:
TRIM_GALORE (ch_read_files, params.outdir, params.trim_galore_args, params.verbose)
}

View file

@ -1,2 +0,0 @@
// docker.enabled = true
params.outdir = './results'

View file

@ -1,97 +0,0 @@
SUMMARISING RUN PARAMETERS
==========================
Input filename: test_R1.fastq.gz
Trimming mode: paired-end
Trim Galore version: 0.6.5
Cutadapt version: 2.3
Number of cores used for trimming: 1
Quality Phred score cutoff: 20
Quality encoding type selected: ASCII+33
Using Nextera adapter for trimming (count: 83). Second best hit was smallRNA (count: 0)
Adapter sequence: 'CTGTCTCTTATA' (Nextera Transposase sequence; auto-detected)
Maximum trimming error rate: 0.1 (default)
Minimum required adapter overlap (stringency): 1 bp
Minimum required sequence length for both reads before a sequence pair gets removed: 20 bp
Output file will be GZIP compressed
This is cutadapt 2.3 with Python 3.7.3
Command line parameters: -j 1 -e 0.1 -q 20 -O 1 -a CTGTCTCTTATA test_R1.fastq.gz
Processing reads on 1 core in single-end mode ...
Finished in 0.19 s (19 us/read; 3.12 M reads/minute).
=== Summary ===
Total reads processed: 10,000
Reads with adapters: 3,225 (32.2%)
Reads written (passing filters): 10,000 (100.0%)
Total basepairs processed: 760,000 bp
Quality-trimmed: 4,492 bp (0.6%)
Total written (filtered): 748,403 bp (98.5%)
=== Adapter 1 ===
Sequence: CTGTCTCTTATA; Type: regular 3'; Length: 12; Trimmed: 3225 times.
No. of allowed errors:
0-9 bp: 0; 10-12 bp: 1
Bases preceding removed adapters:
A: 23.8%
C: 28.2%
G: 22.7%
T: 25.3%
none/other: 0.0%
Overview of removed sequences
length count expect max.err error counts
1 2170 2500.0 0 2170
2 622 625.0 0 622
3 223 156.2 0 223
4 64 39.1 0 64
5 14 9.8 0 14
6 9 2.4 0 9
7 8 0.6 0 8
8 5 0.2 0 5
9 4 0.0 0 4
10 8 0.0 1 7 1
11 3 0.0 1 3
12 4 0.0 1 4
13 6 0.0 1 6
14 5 0.0 1 4 1
15 5 0.0 1 5
16 6 0.0 1 5 1
17 3 0.0 1 3
18 3 0.0 1 3
19 1 0.0 1 1
20 3 0.0 1 3
21 7 0.0 1 7
22 7 0.0 1 7
23 3 0.0 1 3
24 6 0.0 1 6
25 4 0.0 1 4
26 2 0.0 1 2
27 4 0.0 1 4
28 1 0.0 1 1
29 3 0.0 1 3
30 4 0.0 1 4
32 3 0.0 1 3
33 2 0.0 1 1 1
34 1 0.0 1 1
35 1 0.0 1 1
40 1 0.0 1 1
42 1 0.0 1 0 1
45 1 0.0 1 0 1
49 1 0.0 1 0 1
52 1 0.0 1 0 1
56 2 0.0 1 0 2
59 1 0.0 1 0 1
67 1 0.0 1 0 1
70 2 0.0 1 0 2
RUN STATISTICS FOR INPUT FILE: test_R1.fastq.gz
=============================================
10000 sequences processed in total

View file

@ -1 +0,0 @@
../../../../tests/data/fastq/rna/test_R1_val_1.fq.gz

View file

@ -1,100 +0,0 @@
SUMMARISING RUN PARAMETERS
==========================
Input filename: test_R2.fastq.gz
Trimming mode: paired-end
Trim Galore version: 0.6.5
Cutadapt version: 2.3
Number of cores used for trimming: 1
Quality Phred score cutoff: 20
Quality encoding type selected: ASCII+33
Using Nextera adapter for trimming (count: 83). Second best hit was smallRNA (count: 0)
Adapter sequence: 'CTGTCTCTTATA' (Nextera Transposase sequence; auto-detected)
Maximum trimming error rate: 0.1 (default)
Minimum required adapter overlap (stringency): 1 bp
Minimum required sequence length for both reads before a sequence pair gets removed: 20 bp
Output file will be GZIP compressed
This is cutadapt 2.3 with Python 3.7.3
Command line parameters: -j 1 -e 0.1 -q 20 -O 1 -a CTGTCTCTTATA test_R2.fastq.gz
Processing reads on 1 core in single-end mode ...
Finished in 0.22 s (22 us/read; 2.71 M reads/minute).
=== Summary ===
Total reads processed: 10,000
Reads with adapters: 3,295 (33.0%)
Reads written (passing filters): 10,000 (100.0%)
Total basepairs processed: 760,000 bp
Quality-trimmed: 7,096 bp (0.9%)
Total written (filtered): 745,649 bp (98.1%)
=== Adapter 1 ===
Sequence: CTGTCTCTTATA; Type: regular 3'; Length: 12; Trimmed: 3295 times.
No. of allowed errors:
0-9 bp: 0; 10-12 bp: 1
Bases preceding removed adapters:
A: 22.6%
C: 28.2%
G: 23.6%
T: 25.6%
none/other: 0.0%
Overview of removed sequences
length count expect max.err error counts
1 2213 2500.0 0 2213
2 647 625.0 0 647
3 239 156.2 0 239
4 53 39.1 0 53
5 10 9.8 0 10
6 7 2.4 0 7
7 8 0.6 0 8
8 5 0.2 0 5
9 5 0.0 0 5
10 10 0.0 1 8 2
11 2 0.0 1 2
12 4 0.0 1 4
13 7 0.0 1 7
14 3 0.0 1 3
15 4 0.0 1 4
16 5 0.0 1 5
17 3 0.0 1 3
18 5 0.0 1 4 1
19 2 0.0 1 1 1
20 3 0.0 1 3
21 7 0.0 1 7
22 6 0.0 1 6
23 3 0.0 1 3
24 7 0.0 1 7
25 4 0.0 1 4
26 2 0.0 1 2
27 4 0.0 1 4
28 1 0.0 1 1
29 3 0.0 1 3
30 4 0.0 1 4
32 3 0.0 1 3
33 1 0.0 1 1
34 1 0.0 1 1
35 2 0.0 1 1 1
40 1 0.0 1 0 1
41 1 0.0 1 1
46 1 0.0 1 0 1
48 1 0.0 1 0 1
49 2 0.0 1 0 2
56 2 0.0 1 0 2
59 1 0.0 1 0 1
70 1 0.0 1 0 1
73 2 0.0 1 0 2
RUN STATISTICS FOR INPUT FILE: test_R2.fastq.gz
=============================================
10000 sequences processed in total
Total number of sequences analysed for the sequence pair length validation: 10000
Number of sequence pairs removed because at least one read was shorter than the length cutoff (20 bp): 21 (0.21%)

View file

@ -1 +0,0 @@
../../../../tests/data/fastq/rna/test_R2_val_2.fq.gz