annotate rgFastQC.xml @ 19:9568da3ecb00 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 8c357db3dc0861b61f04c7d9f70c5e170e70daa4
author iuc
date Fri, 24 May 2019 13:14:29 -0400
parents 7d3cef9c42ca
children 5b63f9c6c831
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
1 <tool id="fastqc" name="FastQC" version="0.72+galaxy1">
3
36980a78cc83 Uploaded
devteam
parents: 2
diff changeset
2 <description>Read Quality reports</description>
36980a78cc83 Uploaded
devteam
parents: 2
diff changeset
3 <requirements>
18
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
4 <requirement type="package" version="0.11.8">fastqc</requirement>
3
36980a78cc83 Uploaded
devteam
parents: 2
diff changeset
5 </requirements>
18
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
6 <stdio>
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
7 <exit_code range="1:" level="fatal" description="FastQC returned non zero exit code" />
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
8 <exit_code range=":-1" level="fatal" description="FastQC returned non zero exit code" />
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
9 <regex match="There is insufficient memory for the Java Runtime Environment"
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
10 source="stdout"
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
11 level="fatal_oom"
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
12 description="Out of memory error occurred" />
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
13 </stdio>
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
14 <command><![CDATA[
11
f5a25a56ab9d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 8991687e2ec5f75d3841c613ea5d8ffda0389654
iuc
parents: 10
diff changeset
15 #import re
f5a25a56ab9d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 8991687e2ec5f75d3841c613ea5d8ffda0389654
iuc
parents: 10
diff changeset
16 #set input_name = re.sub('[^\w\-\s]', '_', str($input_file.element_identifier))
15
d44f3c8ed647 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit e06f74f574276b793bf9c1c788de8d97db449af2
iuc
parents: 14
diff changeset
17
13
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
18 #if $input_file.ext.endswith('.gz'):
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
19 #set input_file_sl = $input_name + '.gz'
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
20 #elif $input_file.ext.endswith('.bz2'):
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
21 #set input_file_sl = $input_name + '.bz2'
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
22 #else
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
23 #set input_file_sl = $input_name
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
24 #end if
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
25
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
26 #if 'bam' in $input_file.ext:
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
27 #set format = 'bam'
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
28 #elif 'sam' in $input_file.ext:
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
29 #set format = 'sam'
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
30 #else
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
31 #set format = 'fastq'
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
32 #end if
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
33
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
34 ln -s '${input_file}' '${input_file_sl}' &&
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
35 mkdir -p '${html_file.files_path}' &&
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
36 fastqc
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
37 --outdir '${html_file.files_path}'
8
5b995cef2fbb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit bff04a5409662a8968c50501487042a3a0c93702
iuc
parents: 7
diff changeset
38 #if $contaminants.dataset and str($contaminants) > ''
13
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
39 --contaminants '${contaminants}'
8
5b995cef2fbb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit bff04a5409662a8968c50501487042a3a0c93702
iuc
parents: 7
diff changeset
40 #end if
15
d44f3c8ed647 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit e06f74f574276b793bf9c1c788de8d97db449af2
iuc
parents: 14
diff changeset
41
18
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
42 #if $adapters.dataset and str($adapters) > ''
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
43 --adapters '${adapters}'
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
44 #end if
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
45
8
5b995cef2fbb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit bff04a5409662a8968c50501487042a3a0c93702
iuc
parents: 7
diff changeset
46 #if $limits.dataset and str($limits) > ''
13
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
47 --limits '${limits}'
8
5b995cef2fbb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit bff04a5409662a8968c50501487042a3a0c93702
iuc
parents: 7
diff changeset
48 #end if
15
d44f3c8ed647 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit e06f74f574276b793bf9c1c788de8d97db449af2
iuc
parents: 14
diff changeset
49
13
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
50 --quiet
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
51 --extract
18
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
52 #if $min_length:
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
53 --min_length $min_length
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
54 #end if
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
55 $nogroup
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
56 --kmers $kmers
13
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
57 -f '${format}'
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
58 '${input_file_sl}'
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
59
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
60 && cp '${html_file.files_path}'/*/fastqc_data.txt output.txt
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
61 && cp '${html_file.files_path}'/*\.html output.html
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
62
6
e8c90ad3cbf9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit df4c0b0c6372e2984966e220fa42ecd8a3d370e8
devteam
parents: 5
diff changeset
63 ]]></command>
3
36980a78cc83 Uploaded
devteam
parents: 2
diff changeset
64 <inputs>
10
1f6fd7a898bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 4b383d48868d7f3f6d35f242a0ee35953adcb037
iuc
parents: 9
diff changeset
65 <param format="fastq,fastq.gz,fastq.bz2,bam,sam" name="input_file" type="data"
1f6fd7a898bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 4b383d48868d7f3f6d35f242a0ee35953adcb037
iuc
parents: 9
diff changeset
66 label="Short read data from your current history" />
6
e8c90ad3cbf9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit df4c0b0c6372e2984966e220fa42ecd8a3d370e8
devteam
parents: 5
diff changeset
67 <param name="contaminants" type="data" format="tabular" optional="true" label="Contaminant list"
8
5b995cef2fbb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit bff04a5409662a8968c50501487042a3a0c93702
iuc
parents: 7
diff changeset
68 help="tab delimited file with 2 columns: name and sequence. For example: Illumina Small RNA RT Primer CAAGCAGAAGACGGCATACGA" />
18
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
69 <param argument="--adapters" type="data" format="tabular" optional="true" label="Adapter list"
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
70 help="list of adapters adapter sequences which will be explicity searched against the library. tab delimited file with 2 columns: name and sequence." />
3
36980a78cc83 Uploaded
devteam
parents: 2
diff changeset
71 <param name="limits" type="data" format="txt" optional="true" label="Submodule and Limit specifing file"
8
5b995cef2fbb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit bff04a5409662a8968c50501487042a3a0c93702
iuc
parents: 7
diff changeset
72 help="a file that specifies which submodules are to be executed (default=all) and also specifies the thresholds for the each submodules warning parameter" />
18
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
73 <param argument="--nogroup" type="boolean" truevalue="--nogroup" falsevalue="" checked="False"
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
74 label="Disable grouping of bases for reads >50bp" help="Using this option will cause fastqc to crash and burn if you use it on really long reads, and your plots may end up a ridiculous size. You have been warned!"/>
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
75 <param argument="--min_length" type="integer" value="" optional="true"
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
76 label="Lower limit on the length of the sequence to be shown in the report"
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
77 help=" As long as you set this to a value greater or equal to your longest read length then this will be the sequence length used to create your read groups. This can be useful for making directly comaparable statistics from datasets with somewhat variable read lengths."/>
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
78 <param argument="--kmers" type="integer" value="7" min="2" max="10"
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
79 label="length of Kmer to look for" help="note: the Kmer test is disabled and needs to be enabled using a custom Submodule and limits file"/>
3
36980a78cc83 Uploaded
devteam
parents: 2
diff changeset
80 </inputs>
36980a78cc83 Uploaded
devteam
parents: 2
diff changeset
81 <outputs>
13
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
82 <data format="html" name="html_file" from_work_dir="output.html" label="${tool.name} on ${on_string}: Webpage" />
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
83 <data format="txt" name="text_file" from_work_dir="output.txt" label="${tool.name} on ${on_string}: RawData" />
3
36980a78cc83 Uploaded
devteam
parents: 2
diff changeset
84 </outputs>
36980a78cc83 Uploaded
devteam
parents: 2
diff changeset
85 <tests>
36980a78cc83 Uploaded
devteam
parents: 2
diff changeset
86 <test>
18
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
87 <param name="input_file" value="1000trimmed.fastq" />
19
9568da3ecb00 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 8c357db3dc0861b61f04c7d9f70c5e170e70daa4
iuc
parents: 18
diff changeset
88 <output name="html_file" file="fastqc_report.html" ftype="html" lines_diff="2"/>
18
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
89 <output name="text_file" file="fastqc_data.txt" ftype="txt"/>
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
90 </test>
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
91 <test>
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
92 <param name="input_file" value="1000trimmed.fastq" />
3
36980a78cc83 Uploaded
devteam
parents: 2
diff changeset
93 <param name="contaminants" value="fastqc_contaminants.txt" ftype="tabular" />
19
9568da3ecb00 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 8c357db3dc0861b61f04c7d9f70c5e170e70daa4
iuc
parents: 18
diff changeset
94 <output name="html_file" file="fastqc_report_contaminants.html" ftype="html" lines_diff="2"/>
18
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
95 <output name="text_file" file="fastqc_data_contaminants.txt" ftype="txt"/>
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
96 </test>
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
97 <test>
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
98 <param name="input_file" value="1000trimmed.fastq" />
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
99 <param name="adapters" value="fastqc_adapters.txt" ftype="tabular" />
19
9568da3ecb00 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 8c357db3dc0861b61f04c7d9f70c5e170e70daa4
iuc
parents: 18
diff changeset
100 <output name="html_file" file="fastqc_report_adapters.html" ftype="html" lines_diff="2"/>
18
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
101 <output name="text_file" file="fastqc_data_adapters.txt" ftype="txt"/>
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
102 </test>
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
103 <test>
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
104 <param name="input_file" value="1000trimmed.fastq" />
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
105 <param name="limits" value="fastqc_customlimits.txt" ftype="txt" />
19
9568da3ecb00 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 8c357db3dc0861b61f04c7d9f70c5e170e70daa4
iuc
parents: 18
diff changeset
106 <output name="html_file" file="fastqc_report_customlimits.html" ftype="html" lines_diff="2"/>
18
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
107 <output name="text_file" file="fastqc_data_customlimits.txt" ftype="txt"/>
3
36980a78cc83 Uploaded
devteam
parents: 2
diff changeset
108 </test>
36980a78cc83 Uploaded
devteam
parents: 2
diff changeset
109 <test>
18
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
110 <param name="input_file" value="1000trimmed.fastq" ftype="fastq" />
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
111 <param name="kmers" value="3" />
3
36980a78cc83 Uploaded
devteam
parents: 2
diff changeset
112 <param name="limits" value="fastqc_customlimits.txt" ftype="txt" />
19
9568da3ecb00 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 8c357db3dc0861b61f04c7d9f70c5e170e70daa4
iuc
parents: 18
diff changeset
113 <output name="html_file" file="fastqc_report_kmer.html" ftype="html" lines_diff="2"/>
18
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
114 <output name="text_file" file="fastqc_data_kmer.txt" ftype="txt"/>
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
115 <assert_command>
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
116 <has_text text="--kmers 3"/>
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
117 </assert_command>
3
36980a78cc83 Uploaded
devteam
parents: 2
diff changeset
118 </test>
7
ec73b7c83b2c planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit 8918618a5ef7bdca55a31cd919efa593044a376e
devteam
parents: 6
diff changeset
119 <test>
18
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
120 <param name="input_file" value="1000trimmed.fastq" />
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
121 <param name="min_length" value="108" />
19
9568da3ecb00 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 8c357db3dc0861b61f04c7d9f70c5e170e70daa4
iuc
parents: 18
diff changeset
122 <output name="html_file" file="fastqc_report_min_length.html" ftype="html" lines_diff="2"/>
18
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
123 <output name="text_file" file="fastqc_data_min_length.txt" ftype="txt"/>
8
5b995cef2fbb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit bff04a5409662a8968c50501487042a3a0c93702
iuc
parents: 7
diff changeset
124 </test>
5b995cef2fbb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit bff04a5409662a8968c50501487042a3a0c93702
iuc
parents: 7
diff changeset
125 <test>
18
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
126 <param name="input_file" value="1000trimmed.fastq" ftype="fastq" />
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
127 <param name="nogroup" value="--nogroup" />
19
9568da3ecb00 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 8c357db3dc0861b61f04c7d9f70c5e170e70daa4
iuc
parents: 18
diff changeset
128 <output name="html_file" file="fastqc_report_nogroup.html" ftype="html" lines_diff="2"/>
18
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
129 <output name="text_file" file="fastqc_data_nogroup.txt" ftype="txt"/>
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
130 <assert_command>
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
131 <has_text text="--nogroup"/>
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
132 </assert_command>
13
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
133 </test>
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
134 <test>
7d8c56e1a3aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 11
diff changeset
135 <param name="input_file" value="hisat_output_1.bam" ftype="bam" />
19
9568da3ecb00 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 8c357db3dc0861b61f04c7d9f70c5e170e70daa4
iuc
parents: 18
diff changeset
136 <output name="html_file" file="fastqc_report_hisat.html" ftype="html" lines_diff="2"/>
18
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
137 <output name="text_file" file="fastqc_data_hisat.txt" ftype="txt"/>
7
ec73b7c83b2c planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit 8918618a5ef7bdca55a31cd919efa593044a376e
devteam
parents: 6
diff changeset
138 </test>
3
36980a78cc83 Uploaded
devteam
parents: 2
diff changeset
139 </tests>
18
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
140 <help><![CDATA[
0
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
141 .. class:: infomark
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
142
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
143 **Purpose**
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
144
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
145 FastQC aims to provide a simple way to do some quality control checks on raw
6
e8c90ad3cbf9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit df4c0b0c6372e2984966e220fa42ecd8a3d370e8
devteam
parents: 5
diff changeset
146 sequence data coming from high throughput sequencing pipelines.
18
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
147 It provides a set of analyses which you can use to get a quick
6
e8c90ad3cbf9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit df4c0b0c6372e2984966e220fa42ecd8a3d370e8
devteam
parents: 5
diff changeset
148 impression of whether your data has any problems of
0
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
149 which you should be aware before doing any further analysis.
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
150
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
151 The main functions of FastQC are:
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
152
8
5b995cef2fbb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit bff04a5409662a8968c50501487042a3a0c93702
iuc
parents: 7
diff changeset
153 - Import of data from BAM, SAM or FastQ/FastQ.gz files (any variant),
0
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
154 - Providing a quick overview to tell you in which areas there may be problems
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
155 - Summary graphs and tables to quickly assess your data
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
156 - Export of results to an HTML based permanent report
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
157 - Offline operation to allow automated generation of reports without running the interactive application
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
158
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
159 -----
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
160
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
161 .. class:: infomark
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
162
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
163 **FastQC**
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
164
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
165 This is a Galaxy wrapper. It merely exposes the external package FastQC_ which is documented at FastQC_
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
166 Kindly acknowledge it as well as this tool if you use it.
10
1f6fd7a898bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 4b383d48868d7f3f6d35f242a0ee35953adcb037
iuc
parents: 9
diff changeset
167 FastQC incorporates the Picard-tools_ libraries for SAM/BAM processing.
0
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
168
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
169 The contaminants file parameter was borrowed from the independently developed
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
170 fastqcwrapper contributed to the Galaxy Community Tool Shed by J. Johnson.
1
67355741fbc3 Uploaded from GH
devteam
parents: 0
diff changeset
171 Adaption to version 0.11.2 by T. McGowan.
0
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
172
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
173 -----
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
174
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
175 .. class:: infomark
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
176
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
177 **Inputs and outputs**
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
178
6
e8c90ad3cbf9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit df4c0b0c6372e2984966e220fa42ecd8a3d370e8
devteam
parents: 5
diff changeset
179 FastQC_ is the best place to look for documentation - it's very good.
0
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
180 A summary follows below for those in a tearing hurry.
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
181
7
ec73b7c83b2c planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit 8918618a5ef7bdca55a31cd919efa593044a376e
devteam
parents: 6
diff changeset
182 This wrapper will accept a Galaxy fastq, fastq.gz, sam or bam as the input read file to check.
0
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
183 It will also take an optional file containing a list of contaminants information, in the form of
1
67355741fbc3 Uploaded from GH
devteam
parents: 0
diff changeset
184 a tab-delimited file with 2 columns, name and sequence. As another option the tool takes a custom
67355741fbc3 Uploaded from GH
devteam
parents: 0
diff changeset
185 limits.txt file that allows setting the warning thresholds for the different modules and also specifies
67355741fbc3 Uploaded from GH
devteam
parents: 0
diff changeset
186 which modules to include in the output.
0
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
187
1
67355741fbc3 Uploaded from GH
devteam
parents: 0
diff changeset
188 The tool produces a basic text and a HTML output file that contain all of the results, including the following:
0
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
189
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
190 - Basic Statistics
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
191 - Per base sequence quality
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
192 - Per sequence quality scores
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
193 - Per base sequence content
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
194 - Per base GC content
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
195 - Per sequence GC content
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
196 - Per base N content
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
197 - Sequence Length Distribution
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
198 - Sequence Duplication Levels
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
199 - Overrepresented sequences
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
200 - Kmer Content
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
201
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
202 All except Basic Statistics and Overrepresented sequences are plots.
9
0a7c65540937 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 168f7aeb0f9f38de6dec873f3cbf0c30014fdd72
iuc
parents: 8
diff changeset
203 .. _FastQC: http://www.bioinformatics.babraham.ac.uk/projects/fastqc/
10
1f6fd7a898bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 4b383d48868d7f3f6d35f242a0ee35953adcb037
iuc
parents: 9
diff changeset
204 .. _Picard-tools: https://broadinstitute.github.io/picard/
18
7d3cef9c42ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 89976e27bd11f1da3c95a5df6b67297496a8a89b
iuc
parents: 17
diff changeset
205 ]]></help>
2
bf15645bae10 Uploaded from GH
devteam
parents: 1
diff changeset
206 <citations>
bf15645bae10 Uploaded from GH
devteam
parents: 1
diff changeset
207 <citation type="bibtex">
8
5b995cef2fbb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit bff04a5409662a8968c50501487042a3a0c93702
iuc
parents: 7
diff changeset
208 @unpublished{andrews_s,
2
bf15645bae10 Uploaded from GH
devteam
parents: 1
diff changeset
209 author = {Andrews, S.},
bf15645bae10 Uploaded from GH
devteam
parents: 1
diff changeset
210 keywords = {bioinformatics, ngs, qc},
bf15645bae10 Uploaded from GH
devteam
parents: 1
diff changeset
211 priority = {2},
bf15645bae10 Uploaded from GH
devteam
parents: 1
diff changeset
212 title = {{FastQC A Quality Control tool for High Throughput Sequence Data}},
bf15645bae10 Uploaded from GH
devteam
parents: 1
diff changeset
213 url = {http://www.bioinformatics.babraham.ac.uk/projects/fastqc/}
bf15645bae10 Uploaded from GH
devteam
parents: 1
diff changeset
214 }
bf15645bae10 Uploaded from GH
devteam
parents: 1
diff changeset
215 </citation>
bf15645bae10 Uploaded from GH
devteam
parents: 1
diff changeset
216 </citations>
0
d5e4121e45ed Imported from capsule None
devteam
parents:
diff changeset
217 </tool>