annotate fastx_renamer.xml @ 2:2b324adf4e58 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_renamer commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
author iuc
date Tue, 08 May 2018 12:52:31 -0400
parents defaa5ba1ee2
children d8baeed2ce62
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
2b324adf4e58 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_renamer commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
1 <tool id="cshl_fastx_renamer" name="Rename sequences" version="@VERSION@+galaxy0" >
1
defaa5ba1ee2 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
2 <description></description>
2
2b324adf4e58 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_renamer commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
3 <macros>
2b324adf4e58 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_renamer commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
4 <import>macros.xml</import>
2b324adf4e58 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_renamer commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
5 </macros>
2b324adf4e58 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_renamer commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
6 <expand macro="requirements" />
2b324adf4e58 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_renamer commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
2b324adf4e58 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_renamer commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
8 @CATS@ fastx_renamer
2b324adf4e58 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_renamer commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
9 -n $TYPE
2b324adf4e58 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_renamer commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
10 -o '$output'
2b324adf4e58 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_renamer commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
11 -v
2b324adf4e58 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_renamer commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
12 @FQQUAL@
2b324adf4e58 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_renamer commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
13 ]]></command>
0
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
14
1
defaa5ba1ee2 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
15 <inputs>
2
2b324adf4e58 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_renamer commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
16 <expand macro="fastx_input" />
0
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
17
1
defaa5ba1ee2 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
18 <param name="TYPE" type="select" label="Rename sequence identifiers to">
defaa5ba1ee2 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
19 <option value="SEQ">Nucleotides sequence</option>
defaa5ba1ee2 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
20 <option value="COUNT">Numeric Counter</option>
defaa5ba1ee2 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
21 </param>
defaa5ba1ee2 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
22 </inputs>
0
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
23
1
defaa5ba1ee2 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
24 <outputs>
2
2b324adf4e58 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_renamer commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
25 <data name="output" format_source="input" metadata_source="input" />
1
defaa5ba1ee2 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
26 </outputs>
defaa5ba1ee2 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
27 <tests>
2
2b324adf4e58 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_renamer commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
28 <test>
2b324adf4e58 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_renamer commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
29 <param name="input" value="fastx_renamer-in1.fastq" />
2b324adf4e58 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_renamer commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
30 <param name="TYPE" value="SEQ" />
2b324adf4e58 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_renamer commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
31 <output name="output" file="fastx_renamer-out1.fastq" />
2b324adf4e58 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_renamer commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
32 </test>
1
defaa5ba1ee2 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
33 </tests>
2
2b324adf4e58 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_renamer commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
34 <help><![CDATA[
0
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
35 **What it does**
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
36
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
37 This tool renames the sequence identifiers in a FASTQ/A file.
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
38
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
39 .. class:: infomark
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
40
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
41 Use this tool at the beginning of your workflow, as a way to keep the original sequence (before trimming, clipping, barcode-removal, etc).
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
42
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
43 --------
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
44
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
45 **Example**
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
46
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
47 The following Solexa-FASTQ file::
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
48
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
49 @CSHL_4_FC042GAMMII_2_1_517_596
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
50 GGTCAATGATGAGTTGGCACTGTAGGCACCATCAAT
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
51 +CSHL_4_FC042GAMMII_2_1_517_596
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
52 40 40 40 40 40 40 40 40 40 40 38 40 40 40 40 40 14 40 40 40 40 40 36 40 13 14 24 24 9 24 9 40 10 10 15 40
1
defaa5ba1ee2 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
53
0
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
54 Renamed to **nucleotides sequence**::
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
55
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
56 @GGTCAATGATGAGTTGGCACTGTAGGCACCATCAAT
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
57 GGTCAATGATGAGTTGGCACTGTAGGCACCATCAAT
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
58 +GGTCAATGATGAGTTGGCACTGTAGGCACCATCAAT
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
59 40 40 40 40 40 40 40 40 40 40 38 40 40 40 40 40 14 40 40 40 40 40 36 40 13 14 24 24 9 24 9 40 10 10 15 40
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
60
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
61 Renamed to **numeric counter**::
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
62
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
63 @1
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
64 GGTCAATGATGAGTTGGCACTGTAGGCACCATCAAT
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
65 +1
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
66 40 40 40 40 40 40 40 40 40 40 38 40 40 40 40 40 14 40 40 40 40 40 36 40 13 14 24 24 9 24 9 40 10 10 15 40
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
67
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
68 ------
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
69
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
70 This tool is based on `FASTX-toolkit`__ by Assaf Gordon.
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
71
1
defaa5ba1ee2 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
72 .. __: http://hannonlab.cshl.edu/fastx_toolkit/
2
2b324adf4e58 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_renamer commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
73 ]]></help>
2b324adf4e58 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_renamer commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
74 <expand macro="citations" />
0
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
75 </tool>