annotate rgFastQC.xml @ 15:2b0c9d9fc6ca draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
author iuc
date Fri, 24 Nov 2017 08:18:41 -0500
parents 9337dd1fbc66
children ff9530579d1f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
15
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
1 <tool id="fastqc" name="FastQC" version="0.70">
3
0b201de108b9 Uploaded
devteam
parents: 2
diff changeset
2 <description>Read Quality reports</description>
0b201de108b9 Uploaded
devteam
parents: 2
diff changeset
3 <requirements>
8
06819360a9e2 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit df4c0b0c6372e2984966e220fa42ecd8a3d370e8
devteam
parents: 7
diff changeset
4 <requirement type="package" version="0.11.5">fastqc</requirement>
3
0b201de108b9 Uploaded
devteam
parents: 2
diff changeset
5 </requirements>
13
9337dd1fbc66 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 8991687e2ec5f75d3841c613ea5d8ffda0389654
iuc
parents: 12
diff changeset
6 <command detect_errors="exit_code"><![CDATA[
9337dd1fbc66 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 8991687e2ec5f75d3841c613ea5d8ffda0389654
iuc
parents: 12
diff changeset
7 #import re
9337dd1fbc66 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 8991687e2ec5f75d3841c613ea5d8ffda0389654
iuc
parents: 12
diff changeset
8 #set input_name = re.sub('[^\w\-\s]', '_', str($input_file.element_identifier))
15
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
9
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
10 #if $input_file.ext.endswith('.gz'):
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
11 #set input_file_sl = $input_name + '.gz'
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
12 #elif $input_file.ext.endswith('.bz2'):
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
13 #set input_file_sl = $input_name + '.bz2'
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
14 #else
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
15 #set input_file_sl = $input_name
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
16 #end if
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
17
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
18 #if 'bam' in $input_file.ext:
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
19 #set format = 'bam'
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
20 #elif 'sam' in $input_file.ext:
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
21 #set format = 'sam'
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
22 #else
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
23 #set format = 'fastq'
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
24 #end if
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
25
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
26
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
27 ln -s '${input_file}' '${input_file_sl}' &&
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
28 mkdir -p '${html_file.files_path}' &&
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
29 fastqc
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
30 --outdir '${html_file.files_path}'
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
31
10
a00a6402d09a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 9
diff changeset
32 #if $contaminants.dataset and str($contaminants) > ''
15
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
33 --contaminants '${contaminants}'
10
a00a6402d09a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 9
diff changeset
34 #end if
15
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
35
10
a00a6402d09a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 9
diff changeset
36 #if $limits.dataset and str($limits) > ''
15
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
37 --limits '${limits}'
10
a00a6402d09a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 9
diff changeset
38 #end if
15
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
39
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
40 --quiet
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
41 --extract
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
42 -f '${format}'
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
43 '${input_file_sl}'
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
44
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
45 && cp '${html_file.files_path}'/*/fastqc_data.txt output.txt
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
46 && cp '${html_file.files_path}'/*\.html output.html
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
47
8
06819360a9e2 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit df4c0b0c6372e2984966e220fa42ecd8a3d370e8
devteam
parents: 7
diff changeset
48 ]]></command>
3
0b201de108b9 Uploaded
devteam
parents: 2
diff changeset
49 <inputs>
12
484e86282f4b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 4b383d48868d7f3f6d35f242a0ee35953adcb037
iuc
parents: 11
diff changeset
50 <param format="fastq,fastq.gz,fastq.bz2,bam,sam" name="input_file" type="data"
484e86282f4b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 4b383d48868d7f3f6d35f242a0ee35953adcb037
iuc
parents: 11
diff changeset
51 label="Short read data from your current history" />
8
06819360a9e2 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit df4c0b0c6372e2984966e220fa42ecd8a3d370e8
devteam
parents: 7
diff changeset
52 <param name="contaminants" type="data" format="tabular" optional="true" label="Contaminant list"
10
a00a6402d09a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 9
diff changeset
53 help="tab delimited file with 2 columns: name and sequence. For example: Illumina Small RNA RT Primer CAAGCAGAAGACGGCATACGA" />
3
0b201de108b9 Uploaded
devteam
parents: 2
diff changeset
54 <param name="limits" type="data" format="txt" optional="true" label="Submodule and Limit specifing file"
10
a00a6402d09a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 9
diff changeset
55 help="a file that specifies which submodules are to be executed (default=all) and also specifies the thresholds for the each submodules warning parameter" />
3
0b201de108b9 Uploaded
devteam
parents: 2
diff changeset
56 </inputs>
0b201de108b9 Uploaded
devteam
parents: 2
diff changeset
57 <outputs>
15
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
58 <data format="html" name="html_file" from_work_dir="output.html" label="${tool.name} on ${on_string}: Webpage" />
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
59 <data format="txt" name="text_file" from_work_dir="output.txt" label="${tool.name} on ${on_string}: RawData" />
3
0b201de108b9 Uploaded
devteam
parents: 2
diff changeset
60 </outputs>
0b201de108b9 Uploaded
devteam
parents: 2
diff changeset
61 <tests>
0b201de108b9 Uploaded
devteam
parents: 2
diff changeset
62 <test>
0b201de108b9 Uploaded
devteam
parents: 2
diff changeset
63 <param name="input_file" value="1000gsample.fastq" />
0b201de108b9 Uploaded
devteam
parents: 2
diff changeset
64 <param name="contaminants" value="fastqc_contaminants.txt" ftype="tabular" />
0b201de108b9 Uploaded
devteam
parents: 2
diff changeset
65 <output name="html_file" file="fastqc_report.html" ftype="html" lines_diff="100"/>
15
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
66 <output name="text_file" file="fastqc_data.txt" ftype="txt" lines_diff="2"/>
3
0b201de108b9 Uploaded
devteam
parents: 2
diff changeset
67 </test>
0b201de108b9 Uploaded
devteam
parents: 2
diff changeset
68 <test>
0b201de108b9 Uploaded
devteam
parents: 2
diff changeset
69 <param name="input_file" value="1000gsample.fastq" />
0b201de108b9 Uploaded
devteam
parents: 2
diff changeset
70 <param name="limits" value="fastqc_customlimits.txt" ftype="txt" />
8
06819360a9e2 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit df4c0b0c6372e2984966e220fa42ecd8a3d370e8
devteam
parents: 7
diff changeset
71 <output name="html_file" file="fastqc_report2.html" ftype="html" compare="sim_size" delta="4096"/>
15
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
72 <output name="text_file" file="fastqc_data2.txt" ftype="txt" lines_diff="2"/>
3
0b201de108b9 Uploaded
devteam
parents: 2
diff changeset
73 </test>
9
3a458e268066 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit 8918618a5ef7bdca55a31cd919efa593044a376e
devteam
parents: 8
diff changeset
74 <test>
10
a00a6402d09a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 9
diff changeset
75 <param name="input_file" value="1000gsample.fastq.gz" ftype="fastq.gz" />
a00a6402d09a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 9
diff changeset
76 <param name="contaminants" value="fastqc_contaminants.txt" ftype="tabular" />
a00a6402d09a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 9
diff changeset
77 <output name="html_file" file="fastqc_report.html" ftype="html" lines_diff="100"/>
15
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
78 <output name="text_file" file="fastqc_data.txt" ftype="txt" lines_diff="2"/>
10
a00a6402d09a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 9
diff changeset
79 </test>
a00a6402d09a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 9
diff changeset
80 <test>
a00a6402d09a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 9
diff changeset
81 <param name="input_file" value="1000gsample.fastq.bz2" ftype="fastq.bz2" />
9
3a458e268066 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit 8918618a5ef7bdca55a31cd919efa593044a376e
devteam
parents: 8
diff changeset
82 <param name="contaminants" value="fastqc_contaminants.txt" ftype="tabular" />
3a458e268066 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit 8918618a5ef7bdca55a31cd919efa593044a376e
devteam
parents: 8
diff changeset
83 <output name="html_file" file="fastqc_report.html" ftype="html" lines_diff="100"/>
15
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
84 <output name="text_file" file="fastqc_data.txt" ftype="txt" lines_diff="2"/>
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
85 </test>
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
86 <test>
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
87 <param name="input_file" value="hisat_output_1.bam" ftype="bam" />
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
88 <output name="html_file" file="fastqc_report_hisat.html" ftype="html" lines_diff="100"/>
2b0c9d9fc6ca planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 35d722c0cafe2a2f2e4e2f73c265ae56ae237997
iuc
parents: 13
diff changeset
89 <output name="text_file" file="fastqc_data_hisat.txt" ftype="txt" lines_diff="2"/>
9
3a458e268066 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit 8918618a5ef7bdca55a31cd919efa593044a376e
devteam
parents: 8
diff changeset
90 </test>
3
0b201de108b9 Uploaded
devteam
parents: 2
diff changeset
91 </tests>
0b201de108b9 Uploaded
devteam
parents: 2
diff changeset
92 <help>
0
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
93 .. class:: infomark
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
94
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
95 **Purpose**
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
96
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
97 FastQC aims to provide a simple way to do some quality control checks on raw
8
06819360a9e2 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit df4c0b0c6372e2984966e220fa42ecd8a3d370e8
devteam
parents: 7
diff changeset
98 sequence data coming from high throughput sequencing pipelines.
0
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
99 It provides a modular set of analyses which you can use to give a quick
8
06819360a9e2 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit df4c0b0c6372e2984966e220fa42ecd8a3d370e8
devteam
parents: 7
diff changeset
100 impression of whether your data has any problems of
0
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
101 which you should be aware before doing any further analysis.
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
102
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
103 The main functions of FastQC are:
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
104
10
a00a6402d09a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 9
diff changeset
105 - Import of data from BAM, SAM or FastQ/FastQ.gz files (any variant),
0
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
106 - Providing a quick overview to tell you in which areas there may be problems
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
107 - Summary graphs and tables to quickly assess your data
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
108 - Export of results to an HTML based permanent report
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
109 - Offline operation to allow automated generation of reports without running the interactive application
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
110
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
111 -----
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
112
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
113 .. class:: infomark
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
114
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
115 **FastQC**
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
116
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
117 This is a Galaxy wrapper. It merely exposes the external package FastQC_ which is documented at FastQC_
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
118 Kindly acknowledge it as well as this tool if you use it.
12
484e86282f4b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 4b383d48868d7f3f6d35f242a0ee35953adcb037
iuc
parents: 11
diff changeset
119 FastQC incorporates the Picard-tools_ libraries for SAM/BAM processing.
0
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
120
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
121 The contaminants file parameter was borrowed from the independently developed
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
122 fastqcwrapper contributed to the Galaxy Community Tool Shed by J. Johnson.
1
8fae48caaf06 Uploaded form GH
devteam
parents: 0
diff changeset
123 Adaption to version 0.11.2 by T. McGowan.
0
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
124
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
125 -----
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
126
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
127 .. class:: infomark
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
128
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
129 **Inputs and outputs**
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
130
8
06819360a9e2 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit df4c0b0c6372e2984966e220fa42ecd8a3d370e8
devteam
parents: 7
diff changeset
131 FastQC_ is the best place to look for documentation - it's very good.
0
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
132 A summary follows below for those in a tearing hurry.
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
133
9
3a458e268066 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit 8918618a5ef7bdca55a31cd919efa593044a376e
devteam
parents: 8
diff changeset
134 This wrapper will accept a Galaxy fastq, fastq.gz, sam or bam as the input read file to check.
0
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
135 It will also take an optional file containing a list of contaminants information, in the form of
1
8fae48caaf06 Uploaded form GH
devteam
parents: 0
diff changeset
136 a tab-delimited file with 2 columns, name and sequence. As another option the tool takes a custom
8fae48caaf06 Uploaded form GH
devteam
parents: 0
diff changeset
137 limits.txt file that allows setting the warning thresholds for the different modules and also specifies
8fae48caaf06 Uploaded form GH
devteam
parents: 0
diff changeset
138 which modules to include in the output.
0
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
139
1
8fae48caaf06 Uploaded form GH
devteam
parents: 0
diff changeset
140 The tool produces a basic text and a HTML output file that contain all of the results, including the following:
0
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
141
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
142 - Basic Statistics
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
143 - Per base sequence quality
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
144 - Per sequence quality scores
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
145 - Per base sequence content
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
146 - Per base GC content
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
147 - Per sequence GC content
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
148 - Per base N content
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
149 - Sequence Length Distribution
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
150 - Sequence Duplication Levels
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
151 - Overrepresented sequences
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
152 - Kmer Content
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
153
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
154 All except Basic Statistics and Overrepresented sequences are plots.
11
db2dc6bc8f05 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 168f7aeb0f9f38de6dec873f3cbf0c30014fdd72
iuc
parents: 10
diff changeset
155 .. _FastQC: http://www.bioinformatics.babraham.ac.uk/projects/fastqc/
12
484e86282f4b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 4b383d48868d7f3f6d35f242a0ee35953adcb037
iuc
parents: 11
diff changeset
156 .. _Picard-tools: https://broadinstitute.github.io/picard/
2
d2cf2c0c8a11 Uploaded from GH
devteam
parents: 1
diff changeset
157 </help>
d2cf2c0c8a11 Uploaded from GH
devteam
parents: 1
diff changeset
158 <citations>
d2cf2c0c8a11 Uploaded from GH
devteam
parents: 1
diff changeset
159 <citation type="bibtex">
10
a00a6402d09a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 9
diff changeset
160 @unpublished{andrews_s,
2
d2cf2c0c8a11 Uploaded from GH
devteam
parents: 1
diff changeset
161 author = {Andrews, S.},
d2cf2c0c8a11 Uploaded from GH
devteam
parents: 1
diff changeset
162 keywords = {bioinformatics, ngs, qc},
d2cf2c0c8a11 Uploaded from GH
devteam
parents: 1
diff changeset
163 priority = {2},
d2cf2c0c8a11 Uploaded from GH
devteam
parents: 1
diff changeset
164 title = {{FastQC A Quality Control tool for High Throughput Sequence Data}},
d2cf2c0c8a11 Uploaded from GH
devteam
parents: 1
diff changeset
165 url = {http://www.bioinformatics.babraham.ac.uk/projects/fastqc/}
d2cf2c0c8a11 Uploaded from GH
devteam
parents: 1
diff changeset
166 }
d2cf2c0c8a11 Uploaded from GH
devteam
parents: 1
diff changeset
167 </citation>
d2cf2c0c8a11 Uploaded from GH
devteam
parents: 1
diff changeset
168 </citations>
0
e28c965eeed4 Imported from capsule None
devteam
parents:
diff changeset
169 </tool>