annotate fastx_collapser.xml @ 2:17bfc147c9ea draft

planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
author devteam
date Tue, 13 Oct 2015 12:41:05 -0400
parents 460c78dbadf8
children 7bda0f25191f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
1 <tool id="cshl_fastx_collapser" version="1.0.0" name="Collapse">
2
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
2 <description>sequences</description>
0
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
3 <requirements>
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
4 <requirement type="package" version="0.0.13">fastx_toolkit</requirement>
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
5 </requirements>
2
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
6 <command>
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
7 <![CDATA[
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
8 zcat -f < '$input' | fastx_collapser -v -o '$output'
0
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
9 #if $input.ext == "fastqsanger":
2
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
10 -Q 33
0
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
11 #end if
2
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
12 ]]>
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
13 </command>
0
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
14
2
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
15 <inputs>
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
16 <param format="fasta,fastqsanger,fastqsolexa" name="input" type="data" label="Library to collapse" />
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
17 </inputs>
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
18 <outputs>
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
19 <data format="fasta" name="output" metadata_source="input" />
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
20 </outputs>
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
21 <!-- The order of sequences in the test output differ between 32 bit and 64 bit machines.
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
22 <tests>
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
23 <test>
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
24 <param name="input" value="fasta_collapser1.fasta" />
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
25 <param name="output" file="fasta_collapser1.out" />
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
26 </test>
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
27 </tests>
0
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
28 -->
2
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
29 <help>
0
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
30 **What it does**
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
31
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
32 This tool collapses identical sequences in a FASTA file into a single sequence.
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
33
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
34 --------
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
35
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
36 **Example**
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
37
2
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
38 Example Input File (Sequence "ATAT" appears multiple times)::
0
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
39
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
40 >CSHL_2_FC0042AGLLOO_1_1_605_414
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
41 TGCG
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
42 >CSHL_2_FC0042AGLLOO_1_1_537_759
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
43 ATAT
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
44 >CSHL_2_FC0042AGLLOO_1_1_774_520
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
45 TGGC
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
46 >CSHL_2_FC0042AGLLOO_1_1_742_502
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
47 ATAT
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
48 >CSHL_2_FC0042AGLLOO_1_1_781_514
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
49 TGAG
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
50 >CSHL_2_FC0042AGLLOO_1_1_757_487
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
51 TTCA
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
52 >CSHL_2_FC0042AGLLOO_1_1_903_769
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
53 ATAT
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
54 >CSHL_2_FC0042AGLLOO_1_1_724_499
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
55 ATAT
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
56
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
57 Example Output file::
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
58
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
59 >1-1
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
60 TGCG
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
61 >2-4
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
62 ATAT
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
63 >3-1
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
64 TGGC
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
65 >4-1
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
66 TGAG
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
67 >5-1
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
68 TTCA
2
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
69
0
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
70 .. class:: infomark
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
71
2
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
72 Original Sequence Names / Lane descriptions (e.g. "CSHL_2_FC0042AGLLOO_1_1_742_502") are discarded.
0
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
73
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
74 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
75
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
76 The following output::
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
77
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
78 >2-4
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
79 ATAT
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
80
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
81 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
82
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
83
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
84 ------
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
85
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
86 This tool is based on `FASTX-toolkit`__ by Assaf Gordon.
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
87
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
88 .. __: http://hannonlab.cshl.edu/fastx_toolkit/
2
17bfc147c9ea planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
89 </help>
0
9246516d9dd5 Uploaded
devteam
parents:
diff changeset
90 </tool>