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