Mercurial > repos > devteam > fastqc
annotate rgFastQC.xml @ 12:484e86282f4b draft
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 4b383d48868d7f3f6d35f242a0ee35953adcb037
author | iuc |
---|---|
date | Mon, 15 May 2017 08:34:57 -0400 |
parents | db2dc6bc8f05 |
children | 9337dd1fbc66 |
rev | line source |
---|---|
11
db2dc6bc8f05
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 168f7aeb0f9f38de6dec873f3cbf0c30014fdd72
iuc
parents:
10
diff
changeset
|
1 <tool id="fastqc" name="FastQC" version="0.68"> |
3 | 2 <description>Read Quality reports</description> |
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 | 5 </requirements> |
6 <stdio> | |
7 <exit_code range="1:" /> | |
8 <exit_code range=":-1" /> | |
9 <regex match="Error:" /> | |
10 <regex match="Exception:" /> | |
11 </stdio> | |
8
06819360a9e2
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit df4c0b0c6372e2984966e220fa42ecd8a3d370e8
devteam
parents:
7
diff
changeset
|
12 <command><![CDATA[ |
10
a00a6402d09a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents:
9
diff
changeset
|
13 python '${__tool_directory__}/rgFastQC.py' |
a00a6402d09a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents:
9
diff
changeset
|
14 -i '$input_file' |
a00a6402d09a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents:
9
diff
changeset
|
15 -d '${html_file.files_path}' |
a00a6402d09a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents:
9
diff
changeset
|
16 -o '$html_file' |
a00a6402d09a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents:
9
diff
changeset
|
17 -t '$text_file' |
a00a6402d09a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents:
9
diff
changeset
|
18 -f '${input_file.ext}' |
a00a6402d09a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents:
9
diff
changeset
|
19 -j '${input_file.name}' |
a00a6402d09a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents:
9
diff
changeset
|
20 #if $contaminants.dataset and str($contaminants) > '' |
a00a6402d09a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents:
9
diff
changeset
|
21 -c '$contaminants' |
a00a6402d09a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents:
9
diff
changeset
|
22 #end if |
a00a6402d09a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents:
9
diff
changeset
|
23 #if $limits.dataset and str($limits) > '' |
a00a6402d09a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents:
9
diff
changeset
|
24 -l '$limits' |
a00a6402d09a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents:
9
diff
changeset
|
25 #end if |
8
06819360a9e2
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit df4c0b0c6372e2984966e220fa42ecd8a3d370e8
devteam
parents:
7
diff
changeset
|
26 ]]></command> |
3 | 27 <inputs> |
12
484e86282f4b
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 4b383d48868d7f3f6d35f242a0ee35953adcb037
iuc
parents:
11
diff
changeset
|
28 <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
|
29 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
|
30 <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
|
31 help="tab delimited file with 2 columns: name and sequence. For example: Illumina Small RNA RT Primer CAAGCAGAAGACGGCATACGA" /> |
3 | 32 <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
|
33 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 | 34 </inputs> |
35 <outputs> | |
36 <data format="html" name="html_file" label="${tool.name} on ${on_string}: Webpage" /> | |
37 <data format="txt" name="text_file" label="${tool.name} on ${on_string}: RawData" /> | |
38 </outputs> | |
39 <tests> | |
40 <test> | |
41 <param name="input_file" value="1000gsample.fastq" /> | |
42 <param name="contaminants" value="fastqc_contaminants.txt" ftype="tabular" /> | |
43 <output name="html_file" file="fastqc_report.html" ftype="html" lines_diff="100"/> | |
44 <output name="text_file" file="fastqc_data.txt" ftype="txt" lines_diff="100"/> | |
45 </test> | |
46 <test> | |
47 <param name="input_file" value="1000gsample.fastq" /> | |
48 <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
|
49 <output name="html_file" file="fastqc_report2.html" ftype="html" compare="sim_size" delta="4096"/> |
06819360a9e2
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit df4c0b0c6372e2984966e220fa42ecd8a3d370e8
devteam
parents:
7
diff
changeset
|
50 <output name="text_file" file="fastqc_data2.txt" ftype="txt" compare="sim_size"/> |
3 | 51 </test> |
9
3a458e268066
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit 8918618a5ef7bdca55a31cd919efa593044a376e
devteam
parents:
8
diff
changeset
|
52 <test> |
10
a00a6402d09a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents:
9
diff
changeset
|
53 <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
|
54 <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
|
55 <output name="html_file" file="fastqc_report.html" ftype="html" lines_diff="100"/> |
a00a6402d09a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents:
9
diff
changeset
|
56 <output name="text_file" file="fastqc_data.txt" ftype="txt" lines_diff="100"/> |
a00a6402d09a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents:
9
diff
changeset
|
57 </test> |
a00a6402d09a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents:
9
diff
changeset
|
58 <test> |
a00a6402d09a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents:
9
diff
changeset
|
59 <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
|
60 <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
|
61 <output name="html_file" file="fastqc_report.html" ftype="html" lines_diff="100"/> |
3a458e268066
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit 8918618a5ef7bdca55a31cd919efa593044a376e
devteam
parents:
8
diff
changeset
|
62 <output name="text_file" file="fastqc_data.txt" ftype="txt" lines_diff="100"/> |
3a458e268066
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit 8918618a5ef7bdca55a31cd919efa593044a376e
devteam
parents:
8
diff
changeset
|
63 </test> |
3 | 64 </tests> |
65 <help> | |
0 | 66 .. class:: infomark |
67 | |
68 **Purpose** | |
69 | |
70 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
|
71 sequence data coming from high throughput sequencing pipelines. |
0 | 72 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
|
73 impression of whether your data has any problems of |
0 | 74 which you should be aware before doing any further analysis. |
75 | |
76 The main functions of FastQC are: | |
77 | |
10
a00a6402d09a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fastqc commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents:
9
diff
changeset
|
78 - Import of data from BAM, SAM or FastQ/FastQ.gz files (any variant), |
0 | 79 - Providing a quick overview to tell you in which areas there may be problems |
80 - Summary graphs and tables to quickly assess your data | |
81 - Export of results to an HTML based permanent report | |
82 - Offline operation to allow automated generation of reports without running the interactive application | |
83 | |
84 ----- | |
85 | |
86 .. class:: infomark | |
87 | |
88 **FastQC** | |
89 | |
90 This is a Galaxy wrapper. It merely exposes the external package FastQC_ which is documented at FastQC_ | |
91 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
|
92 FastQC incorporates the Picard-tools_ libraries for SAM/BAM processing. |
0 | 93 |
94 The contaminants file parameter was borrowed from the independently developed | |
95 fastqcwrapper contributed to the Galaxy Community Tool Shed by J. Johnson. | |
1 | 96 Adaption to version 0.11.2 by T. McGowan. |
0 | 97 |
98 ----- | |
99 | |
100 .. class:: infomark | |
101 | |
102 **Inputs and outputs** | |
103 | |
8
06819360a9e2
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit df4c0b0c6372e2984966e220fa42ecd8a3d370e8
devteam
parents:
7
diff
changeset
|
104 FastQC_ is the best place to look for documentation - it's very good. |
0 | 105 A summary follows below for those in a tearing hurry. |
106 | |
9
3a458e268066
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/fastqc commit 8918618a5ef7bdca55a31cd919efa593044a376e
devteam
parents:
8
diff
changeset
|
107 This wrapper will accept a Galaxy fastq, fastq.gz, sam or bam as the input read file to check. |
0 | 108 It will also take an optional file containing a list of contaminants information, in the form of |
1 | 109 a tab-delimited file with 2 columns, name and sequence. As another option the tool takes a custom |
110 limits.txt file that allows setting the warning thresholds for the different modules and also specifies | |
111 which modules to include in the output. | |
0 | 112 |
1 | 113 The tool produces a basic text and a HTML output file that contain all of the results, including the following: |
0 | 114 |
115 - Basic Statistics | |
116 - Per base sequence quality | |
117 - Per sequence quality scores | |
118 - Per base sequence content | |
119 - Per base GC content | |
120 - Per sequence GC content | |
121 - Per base N content | |
122 - Sequence Length Distribution | |
123 - Sequence Duplication Levels | |
124 - Overrepresented sequences | |
125 - Kmer Content | |
126 | |
127 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
|
128 .. _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
|
129 .. _Picard-tools: https://broadinstitute.github.io/picard/ |
2 | 130 </help> |
131 <citations> | |
132 <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
|
133 @unpublished{andrews_s, |
2 | 134 author = {Andrews, S.}, |
135 keywords = {bioinformatics, ngs, qc}, | |
136 priority = {2}, | |
137 title = {{FastQC A Quality Control tool for High Throughput Sequence Data}}, | |
138 url = {http://www.bioinformatics.babraham.ac.uk/projects/fastqc/} | |
139 } | |
140 </citation> | |
141 </citations> | |
0 | 142 </tool> |