annotate fastq_paired_end_joiner.xml @ 1:ce853b881881 draft

Uploaded version 2.0.0 of tool.
author devteam
date Mon, 07 Jul 2014 15:17:40 -0400
parents d86b8db06e05
children ab37758348d0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
1 <tool id="fastq_paired_end_joiner" name="FASTQ joiner" version="2.0.0">
0
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
2 <description>on paired end reads</description>
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
3 <requirements>
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
4 <requirement type="package" version="1.0.0">galaxy_sequence_utils</requirement>
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
5 </requirements>
1
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
6 <command interpreter="python">fastq_paired_end_joiner.py '$input1_file' '${input1_file.extension[len( 'fastq' ):]}' '$input2_file' '${input2_file.extension[len( 'fastq' ):]}' '$output_file' '$style'</command>
0
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
7 <inputs>
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
8 <param name="input1_file" type="data" format="fastqsanger,fastqcssanger" label="Left-hand Reads" />
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
9 <param name="input2_file" type="data" format="fastqsanger,fastqcssanger" label="Right-hand Reads" />
1
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
10 <param name="style" type="select" label="FASTQ Header Style">
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
11 <option value="old" selected="true">old</option>
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
12 <option value="new">new</option>
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
13 </param>
0
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
14 </inputs>
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
15 <outputs>
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
16 <data name="output_file" format="input" />
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
17 </outputs>
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
18 <tests>
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
19 <test>
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
20 <param name="input1_file" value="split_pair_reads_1.fastqsanger" ftype="fastqsanger" />
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
21 <param name="input2_file" value="split_pair_reads_2.fastqsanger" ftype="fastqsanger" />
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
22 <output name="output_file" file="3.fastqsanger" />
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
23 </test>
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
24 </tests>
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
25 <help>
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
26 **What it does**
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
27
1
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
28 This tool joins paired end FASTQ reads from two separate files into a
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
29 single read in one file. The join is performed using sequence
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
30 identifiers, allowing the two files to contain differing ordering. If
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
31 a sequence identifier does not appear in both files, it is excluded
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
32 from the output.
0
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
33
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
34 -----
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
35
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
36 **Input formats**
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
37
1
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
38 Both old and new (from recent Illumina software) style FASTQ headers
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
39 are supported. The following example uses the "old" style.
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
40
0
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
41 Left-hand Read::
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
42
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
43 @HWI-EAS91_1_30788AAXX:7:21:1542:1758/1
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
44 GTCAATTGTACTGGTCAATACTAAAAGAATAGGATC
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
45 +HWI-EAS91_1_30788AAXX:7:21:1542:1758/1
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
46 hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
47
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
48 Right-hand Read::
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
49
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
50 @HWI-EAS91_1_30788AAXX:7:21:1542:1758/2
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
51 GCTCCTAGCATCTGGAGTCTCTATCACCTGAGCCCA
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
52 +HWI-EAS91_1_30788AAXX:7:21:1542:1758/2
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
53 hhhhhhhhhhhhhhhhhhhhhhhh`hfhhVZSWehR
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
54
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
55 -----
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
56
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
57 **Output**
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
58
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
59 A multiple-fastq file, for example::
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
60
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
61 @HWI-EAS91_1_30788AAXX:7:21:1542:1758
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
62 GTCAATTGTACTGGTCAATACTAAAAGAATAGGATCGCTCCTAGCATCTGGAGTCTCTATCACCTGAGCCCA
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
63 +HWI-EAS91_1_30788AAXX:7:21:1542:1758
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
64 hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh`hfhhVZSWehR
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
65
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
66 ------
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
67
1
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
68 **The "new" style**
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
69
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
70 Recent Illumina FASTQ headers are structured as follows::
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
71
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
72 @COORDS FLAGS
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
73 COORDS = INSTRUMENT:RUN_#:FLOWCELL_ID:LANE:TILE:X:Y
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
74 FLAGS = READ:IS_FILTERED:CONTROL_NUMBER:INDEX_SEQUENCE
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
75
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
76 where the whitespace character between COORDS and FLAGS can be either
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
77 a space or a tab.
0
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
78
1
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
79 ------
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
80
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
81 **Credits**
0
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
82
1
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
83 This is an extended version (adds support for "new" style FASTQ headers)
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
84 of D. Blankenberg's fastq joiner:
0
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
85
1
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
86 `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;`_
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
87
ce853b881881 Uploaded version 2.0.0 of tool.
devteam
parents: 0
diff changeset
88 New style header support added by Simone Leo &lt;simone.leo@crs4.it&gt;
0
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
89 </help>
d86b8db06e05 Imported from capsule None
devteam
parents:
diff changeset
90 </tool>