annotate tools/fastq/fastq_to_tabular.xml @ 1:cdcb0ce84a1b

Uploaded
author xuebing
date Fri, 09 Mar 2012 19:45:15 -0500
parents 9071e359b9a3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
1 <tool id="fastq_to_tabular" name="FASTQ to Tabular" version="1.1.0">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description>converter</description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <command interpreter="python">fastq_to_tabular.py '$input_file' '$output_file' $descr_columns '${input_file.extension[len( 'fastq' ):]}'</command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 <param name="input_file" type="data" format="fastqsanger,fastqcssanger,fastqillumina,fastqsolexa" label="FASTQ file to convert" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 <param name="descr_columns" type="integer" size="2" value="1" label="How many columns to divide title string into?" help="Typically 2 to take the ID (first word) and decription (rest) as two columns, or 1 to give a single column">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 <validator type="in_range" min="1" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 <data name="output_file" format="tabular" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 <!-- basic test -->
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 <param name="input_file" value="sanger_full_range_original_sanger.fastqsanger" ftype="fastqsanger" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 <param name="descr_columns" value="1"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 <output name="output_file" file="fastq_to_tabular_out_1.tabular" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 <!-- color space test -->
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 <param name="input_file" value="sanger_full_range_as_cssanger.fastqcssanger" ftype="fastqcssanger" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 <param name="descr_columns" value="1"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 <output name="output_file" file="fastq_to_tabular_out_2.tabular" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 <!-- split title into columns -->
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 <param name="input_file" value="sanger_full_range_original_sanger.fastqsanger" ftype="fastqsanger" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 <param name="descr_columns" value="2"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 <output name="output_file" file="fastq_to_tabular_out_3.tabular" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 **What it does**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 This tool converts FASTQ sequencing reads to a Tabular file.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39 It is conventional to take the first word of the FASTQ "@" title line as the identifier, and any remaining text to be a free form description.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40 It is therefore often useful to split this text into two columns in Galaxy (identifier and any description) by setting **How many columns to divide title string into?** to **2**.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41 In some cases the description can be usefully broken up into more columns -- see the examples .
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43 Tab characters, if present in the source FASTQ title, will be converted to spaces.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47 **Example**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 Consider the following two 454 reads in Sanger FASTQ format (using line wrapping for display, but do note not all tools will accept line wrapped FASTQ files)::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51 @FSRRS4401BE7HA [length=395] [gc=36.46] [flows=800] [phred_min=0] [phred_max=40] [trimmed_length=95]
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52 tcagTTAAGATGGGATAATATCCTCAGATTGCGTGATGAACTTTGTTCTGGTGGAGGAGAAGGAAGTGCATTCGACGTAT
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53 GCCCGTTTGTCGATATTTGtatttaaagtaatccgtcacaaatcagtgacataaatattatttagatttcgggagcaact
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54 ttatttattccacaagcaggtttaaattttaaatttaaattattgcagaagactttaaattaacctcgttgtcggagtca
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55 tttgttcggttattggtcgaaagtaaccncgggaagtgccgaaaactaacaaacaaaagaagatagtgaaattttaatta
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56 aaanaaatagccaaacgtaactaactaaaacggacccgtcgaggaactgccaacggacgacacagggagtagnnn
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57 +FSRRS4401BE7HA [length=395] [gc=36.46] [flows=800] [phred_min=0] [phred_max=40] [trimmed_length=95]
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58 FFFDDDDDDDA666?688FFHGGIIIIIIIIIIIIIIIIIIHHHIIIIIIIIIGHGFFFFF====DFFFFFFFFFFFFFF
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 D???:3104/76=:5...4.3,,,366////4&lt;ABBAAA=CCFDDDDDDDD:666CDFFFF=&lt;ABA=;:333111&lt;===9
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60 9;B889FFFFFFDDBDBDDD=8844231..,,,-,,,,,,,,1133..---17111,,,,,22555131121.--.,333
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61 11,.,,3--,,.,,--,3511123..--!,,,,--,----9,,,,8=,,-,,,-,,,,---26:9:5-..1,,,,11//,
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62 ,,,!,,1917--,,,,-3.,--,,17,,,,---+11113.030000,,,044400036;96662.//;7&gt;&lt;;!!!
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63 @FSRRS4401BRRTC [length=145] [gc=38.62] [flows=800] [phred_min=0] [phred_max=38] [trimmed_length=74]
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64 tcagCCAGCAATTCCGACTTAATTGTTCTTCTTCCATCATTCATCTCGACTAACAGTTCTACGATTAATGAGTTTGGCtt
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65 taatttgttgttcattattgtcacaattacactactgagactgccaaggcacncagggataggnn
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66 +FSRRS4401BRRTC [length=145] [gc=38.62] [flows=800] [phred_min=0] [phred_max=38] [trimmed_length=74]
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67 FFFFFFFFFDDDDFFFFGFDDDDBAAAAA=&lt;4444@@B=555:BBBBB@@?8:8&lt;?&lt;89898&lt;84442;==3,,,514,,
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68 ,11,,,.,,21777555513,..--1115758.//34488&gt;&lt;&lt;;;;;9944/!/4,,,57855!!
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
70 By default this is converted into a 3 column tabular file, with the full FASTQ title used as column 1:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
71
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
72 =================================================================================================== ============== ==============
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
73 FSRRS4401BE7HA [length=395] [gc=36.46] [flows=800] [phred_min=0] [phred_max=40] [trimmed_length=95] tcagTTAA...nnn FFFDDDDD...!!!
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
74 FSRRS4401BRRTC [length=145] [gc=38.62] [flows=800] [phred_min=0] [phred_max=38] [trimmed_length=74] tcagCCAG...gnn FFFFFFFF...5!!
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
75 =================================================================================================== ============== ==============
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
76
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
77 If you specified the title should be turned into 2 columns, you'd get 4 columns in total:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
78
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
79 ============== ==================================================================================== ============== ==============
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
80 FSRRS4401BE7HA [length=395] [gc=36.46] [flows=800] [phred_min=0] [phred_max=40] [trimmed_length=95] tcagTTAA...nnn FFFDDDDD...!!!
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
81 FSRRS4401BRRTC [length=145] [gc=38.62] [flows=800] [phred_min=0] [phred_max=38] [trimmed_length=74] tcagCCAG...gnn FFFFFFFF...5!!
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
82 ============== ==================================================================================== ============== ==============
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
83
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
84 Similarly, for this example treating the title string as 7 columns makes sense:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
85
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
86 ============== ============ ========== =========== ============= ============== =================== ============== ==============
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
87 FSRRS4401BE7HA [length=395] [gc=36.46] [flows=800] [phred_min=0] [phred_max=40] [trimmed_length=95] tcagTTAA...nnn FFFDDDDD...!!!
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
88 FSRRS4401BRRTC [length=145] [gc=38.62] [flows=800] [phred_min=0] [phred_max=38] [trimmed_length=74] tcagCCAG...gnn FFFFFFFF...5!!
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
89 ============== ============ ========== =========== ============= ============== =================== ============== ==============
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
90
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
91 Note the sequences and quality strings have been truncated for display purposes in the above tables.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
92
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
93 ------
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
94
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
95 **Citation**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
96
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
97 If you use this tool, please cite `Blankenberg D, Gordon A, Von Kuster G, Coraor N, Taylor J, Nekrutenko A; Galaxy Team. Manipulation of FASTQ data with Galaxy. Bioinformatics. 2010 Jul 15;26(14):1783-5. &lt;http://www.ncbi.nlm.nih.gov/pubmed/20562416&gt;`_
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
98
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
99
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
100 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
101 </tool>