annotate fastq_paired_end_joiner.xml @ 5:822cc1e6274e draft

planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit 28c441e8aa66a55d276b0f6325d34086eb715872
author devteam
date Sat, 07 Oct 2017 09:58:53 -0400
parents 080a058abf1e
children 09a2199cd356
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
822cc1e6274e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit 28c441e8aa66a55d276b0f6325d34086eb715872
devteam
parents: 4
diff changeset
1 <tool id="fastq_paired_end_joiner" name="FASTQ joiner" version="2.0.1.1">
4
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
2 <description>on paired end reads</description>
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
3 <requirements>
5
822cc1e6274e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit 28c441e8aa66a55d276b0f6325d34086eb715872
devteam
parents: 4
diff changeset
4 <requirement type="package" version="1.1.2">galaxy_sequence_utils</requirement>
4
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
5 </requirements>
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
6 <command><![CDATA[
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
7 gx-fastq-paired-end-joiner '$input1_file' '${input1_file.extension[len('fastq'):]}' '$input2_file' '${input2_file.extension[len('fastq'):]}' '$output_file' $style '${paste_sequence}'
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
8 ]]></command>
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
9 <inputs>
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
10 <param name="input1_file" type="data" format="fastqsanger,fastqcssanger,fastqsanger.gz,fastqcssanger.gz,fastqsanger.bz2,fastqcssanger.bz2" label="Left-hand Reads" />
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
11 <param name="input2_file" type="data" format="fastqsanger,fastqcssanger,fastqsanger.gz,fastqcssanger.gz,fastqsanger.bz2,fastqcssanger.bz2" label="Right-hand Reads" />
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
12 <param name="style" type="select" label="FASTQ Header Style">
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
13 <option value="old" selected="true">old</option>
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
14 <option value="new">new</option>
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
15 </param>
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
16 <param name="paste_sequence" type="text" value="" label="Bases to insert between joined reads" help="Values are in Base-space and quality scores of maximal value will be used"/>
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
17 </inputs>
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
18 <outputs>
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
19 <data name="output_file" format_source="input1_file" />
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
20 </outputs>
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
21 <tests>
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
22 <test>
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
23 <param name="input1_file" value="split_pair_reads_1.fastqsanger" ftype="fastqsanger" />
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
24 <param name="input2_file" value="split_pair_reads_2.fastqsanger" ftype="fastqsanger" />
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
25 <output name="output_file" file="3.fastqsanger" ftype="fastqsanger" />
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
26 </test>
5
822cc1e6274e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit 28c441e8aa66a55d276b0f6325d34086eb715872
devteam
parents: 4
diff changeset
27 <test>
822cc1e6274e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit 28c441e8aa66a55d276b0f6325d34086eb715872
devteam
parents: 4
diff changeset
28 <param name="input1_file" value="split_pair_reads_1.fastqsanger.gz" ftype="fastqsanger.gz" />
822cc1e6274e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit 28c441e8aa66a55d276b0f6325d34086eb715872
devteam
parents: 4
diff changeset
29 <param name="input2_file" value="split_pair_reads_2.fastqsanger.gz" ftype="fastqsanger.gz" />
822cc1e6274e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit 28c441e8aa66a55d276b0f6325d34086eb715872
devteam
parents: 4
diff changeset
30 <output name="output_file" file="3.fastqsanger" ftype="fastqsanger.gz" decompress="true" />
822cc1e6274e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit 28c441e8aa66a55d276b0f6325d34086eb715872
devteam
parents: 4
diff changeset
31 </test>
822cc1e6274e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit 28c441e8aa66a55d276b0f6325d34086eb715872
devteam
parents: 4
diff changeset
32 <test>
822cc1e6274e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit 28c441e8aa66a55d276b0f6325d34086eb715872
devteam
parents: 4
diff changeset
33 <param name="input1_file" value="split_pair_reads_1.fastqsanger.bz2" ftype="fastqsanger.bz2" />
822cc1e6274e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit 28c441e8aa66a55d276b0f6325d34086eb715872
devteam
parents: 4
diff changeset
34 <param name="input2_file" value="split_pair_reads_2.fastqsanger.bz2" ftype="fastqsanger.bz2" />
822cc1e6274e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit 28c441e8aa66a55d276b0f6325d34086eb715872
devteam
parents: 4
diff changeset
35 <output name="output_file" file="3.fastqsanger" ftype="fastqsanger.bz2" decompress="true" />
822cc1e6274e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit 28c441e8aa66a55d276b0f6325d34086eb715872
devteam
parents: 4
diff changeset
36 </test>
4
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
37 </tests>
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
38 <help><![CDATA[
0
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
39 **What it does**
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
40
1
270a8ed8a300 Uploaded tool version 2.0.0 by Simone Leo.
devteam
parents: 0
diff changeset
41 This tool joins paired end FASTQ reads from two separate files into a
270a8ed8a300 Uploaded tool version 2.0.0 by Simone Leo.
devteam
parents: 0
diff changeset
42 single read in one file. The join is performed using sequence
270a8ed8a300 Uploaded tool version 2.0.0 by Simone Leo.
devteam
parents: 0
diff changeset
43 identifiers, allowing the two files to contain differing ordering. If
270a8ed8a300 Uploaded tool version 2.0.0 by Simone Leo.
devteam
parents: 0
diff changeset
44 a sequence identifier does not appear in both files, it is excluded
270a8ed8a300 Uploaded tool version 2.0.0 by Simone Leo.
devteam
parents: 0
diff changeset
45 from the output.
0
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
46
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
47 -----
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
48
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
49 **Input formats**
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
50
1
270a8ed8a300 Uploaded tool version 2.0.0 by Simone Leo.
devteam
parents: 0
diff changeset
51 Both old and new (from recent Illumina software) style FASTQ headers
270a8ed8a300 Uploaded tool version 2.0.0 by Simone Leo.
devteam
parents: 0
diff changeset
52 are supported. The following example uses the "old" style.
270a8ed8a300 Uploaded tool version 2.0.0 by Simone Leo.
devteam
parents: 0
diff changeset
53
0
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
54 Left-hand Read::
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
55
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
56 @HWI-EAS91_1_30788AAXX:7:21:1542:1758/1
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
57 GTCAATTGTACTGGTCAATACTAAAAGAATAGGATC
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
58 +HWI-EAS91_1_30788AAXX:7:21:1542:1758/1
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
59 hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
60
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
61 Right-hand Read::
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
62
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
63 @HWI-EAS91_1_30788AAXX:7:21:1542:1758/2
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
64 GCTCCTAGCATCTGGAGTCTCTATCACCTGAGCCCA
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
65 +HWI-EAS91_1_30788AAXX:7:21:1542:1758/2
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
66 hhhhhhhhhhhhhhhhhhhhhhhh`hfhhVZSWehR
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
67
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
68 -----
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
69
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
70 **Output**
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
71
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
72 A multiple-fastq file, for example::
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
73
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
74 @HWI-EAS91_1_30788AAXX:7:21:1542:1758
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
75 GTCAATTGTACTGGTCAATACTAAAAGAATAGGATCGCTCCTAGCATCTGGAGTCTCTATCACCTGAGCCCA
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
76 +HWI-EAS91_1_30788AAXX:7:21:1542:1758
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
77 hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh`hfhhVZSWehR
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
78
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
79 ------
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
80
1
270a8ed8a300 Uploaded tool version 2.0.0 by Simone Leo.
devteam
parents: 0
diff changeset
81 **The "new" style**
270a8ed8a300 Uploaded tool version 2.0.0 by Simone Leo.
devteam
parents: 0
diff changeset
82
270a8ed8a300 Uploaded tool version 2.0.0 by Simone Leo.
devteam
parents: 0
diff changeset
83 Recent Illumina FASTQ headers are structured as follows::
270a8ed8a300 Uploaded tool version 2.0.0 by Simone Leo.
devteam
parents: 0
diff changeset
84
270a8ed8a300 Uploaded tool version 2.0.0 by Simone Leo.
devteam
parents: 0
diff changeset
85 @COORDS FLAGS
270a8ed8a300 Uploaded tool version 2.0.0 by Simone Leo.
devteam
parents: 0
diff changeset
86 COORDS = INSTRUMENT:RUN_#:FLOWCELL_ID:LANE:TILE:X:Y
270a8ed8a300 Uploaded tool version 2.0.0 by Simone Leo.
devteam
parents: 0
diff changeset
87 FLAGS = READ:IS_FILTERED:CONTROL_NUMBER:INDEX_SEQUENCE
270a8ed8a300 Uploaded tool version 2.0.0 by Simone Leo.
devteam
parents: 0
diff changeset
88
270a8ed8a300 Uploaded tool version 2.0.0 by Simone Leo.
devteam
parents: 0
diff changeset
89 where the whitespace character between COORDS and FLAGS can be either
270a8ed8a300 Uploaded tool version 2.0.0 by Simone Leo.
devteam
parents: 0
diff changeset
90 a space or a tab.
0
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
91
1
270a8ed8a300 Uploaded tool version 2.0.0 by Simone Leo.
devteam
parents: 0
diff changeset
92 ------
270a8ed8a300 Uploaded tool version 2.0.0 by Simone Leo.
devteam
parents: 0
diff changeset
93
270a8ed8a300 Uploaded tool version 2.0.0 by Simone Leo.
devteam
parents: 0
diff changeset
94 **Credits**
0
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
95
4
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
96 New style header support added by Simone Leo <simone.leo@crs4.it> .
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
97 ]]></help>
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
98 <citations>
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
99 <citation type="doi">10.1093/bioinformatics/btq281</citation>
080a058abf1e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_joiner commit f2582539542b33240234e8ea6093e25d0aee9b6a
devteam
parents: 3
diff changeset
100 </citations>
0
2793d1d765b9 Imported from capsule None
devteam
parents:
diff changeset
101 </tool>