annotate fastx_collapser.xml @ 4:1e76bd67fb73 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_collapser commit fd099d17eceaa319fbfe429f4725328d88b18c9f
author iuc
date Thu, 10 Aug 2023 06:51:47 +0000
parents 7bda0f25191f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
1e76bd67fb73 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_collapser commit fd099d17eceaa319fbfe429f4725328d88b18c9f
iuc
parents: 3
diff changeset
1 <tool id="cshl_fastx_collapser" version="1.0.1+galaxy@VERSION_SUFFIX@" profile="22.05" name="Collapse">
2
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
2 <description>sequences</description>
3
7bda0f25191f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_collapser commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
3 <macros>
7bda0f25191f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_collapser commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
4 <import>macros.xml</import>
7bda0f25191f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_collapser commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
5 </macros>
7bda0f25191f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_collapser commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
6 <expand macro="requirements" />
7bda0f25191f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_collapser commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
7bda0f25191f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_collapser commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
8 @CATS@ fastx_collapser -v
7bda0f25191f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_collapser commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
9 -o '$output'
7bda0f25191f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_collapser commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
10 @FQQUAL@
7bda0f25191f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_collapser commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
11 ]]></command>
0
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
12
2
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
13 <inputs>
3
7bda0f25191f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_collapser commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
14 <expand macro="fastx_input" />
2
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
15 </inputs>
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
16 <outputs>
3
7bda0f25191f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_collapser commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
17 <data name="output" format="fasta" metadata_source="input" />
2
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
18 </outputs>
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
19 <tests>
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
20 <test>
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
21 <param name="input" value="fasta_collapser1.fasta" />
3
7bda0f25191f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_collapser commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
22 <!-- The output is sorted differently depending on architecture,
7bda0f25191f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_collapser commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
23 so the sort attribute is needed here -->
7bda0f25191f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_collapser commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
24 <output name="output" file="fasta_collapser1.out" sort="true" />
2
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
25 </test>
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
26 </tests>
3
7bda0f25191f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_collapser commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
27 <help><![CDATA[
0
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
28 **What it does**
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
29
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
30 This tool collapses identical sequences in a FASTA file into a single sequence.
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
31
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
32 --------
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
33
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
34 **Example**
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
35
2
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
36 Example Input File (Sequence "ATAT" appears multiple times)::
0
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
37
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
38 >CSHL_2_FC0042AGLLOO_1_1_605_414
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
39 TGCG
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
40 >CSHL_2_FC0042AGLLOO_1_1_537_759
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
41 ATAT
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
42 >CSHL_2_FC0042AGLLOO_1_1_774_520
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
43 TGGC
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
44 >CSHL_2_FC0042AGLLOO_1_1_742_502
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
45 ATAT
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
46 >CSHL_2_FC0042AGLLOO_1_1_781_514
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
47 TGAG
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
48 >CSHL_2_FC0042AGLLOO_1_1_757_487
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
49 TTCA
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
50 >CSHL_2_FC0042AGLLOO_1_1_903_769
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
51 ATAT
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
52 >CSHL_2_FC0042AGLLOO_1_1_724_499
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
53 ATAT
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
54
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
55 Example Output file::
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
56
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
57 >1-1
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
58 TGCG
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
59 >2-4
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
60 ATAT
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
61 >3-1
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
62 TGGC
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
63 >4-1
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
64 TGAG
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
65 >5-1
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
66 TTCA
2
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
67
0
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
68 .. class:: infomark
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
69
2
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
70 Original Sequence Names / Lane descriptions (e.g. "CSHL_2_FC0042AGLLOO_1_1_742_502") are discarded.
0
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
71
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
72 The output sequence name is composed of two numbers: the first is the sequence's number, the second is the multiplicity value.
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
73
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
74 The following output::
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
75
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
76 >2-4
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
77 ATAT
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
78
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
79 means that the sequence "ATAT" is the second sequence in the file, and it appeared 4 times in the input FASTA file.
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
80
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
81 ------
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
82
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
83 This tool is based on `FASTX-toolkit`__ by Assaf Gordon.
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
84
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
85 .. __: http://hannonlab.cshl.edu/fastx_toolkit/
3
7bda0f25191f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_collapser commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
86 ]]></help>
7bda0f25191f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_collapser commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
87 <expand macro="citations" />
0
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
88 </tool>