annotate fasta_formatter.xml @ 3:4f66158f20f2 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_formatter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
author iuc
date Tue, 08 May 2018 12:33:30 -0400
parents 61469a8970cd
children 381e98a18f01
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
4f66158f20f2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_formatter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
1 <tool id="cshl_fasta_formatter" version="1.0.1" name="FASTA Width">
2
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
2 <description>formatter</description>
3
4f66158f20f2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_formatter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
3 <macros>
4f66158f20f2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_formatter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
4 <import>macros.xml</import>
4f66158f20f2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_formatter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
5 </macros>
4f66158f20f2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_formatter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
6 <expand macro="requirements" />
2
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
7 <!--
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
8 Note:
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
9 fasta_formatter also has a tabular output mode (-t),
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
10 but Galaxy already contains such a tool, so no need
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
11 to offer the user a duplicated tool.
0
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
12
2
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
13 So this XML tool only changes the width (line-wrapping) of a
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
14 FASTA file.
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
15 -->
3
4f66158f20f2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_formatter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
16 <command detect_errors="exit_code"><![CDATA[
4f66158f20f2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_formatter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
17 @CATS@ fasta_formatter
4f66158f20f2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_formatter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
18 -w $width
4f66158f20f2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_formatter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
19 -o '$output'
4f66158f20f2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_formatter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
20 ]]></command>
2
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
21 <inputs>
3
4f66158f20f2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_formatter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
22 <expand macro="fasta_input" />
0
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
23
2
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
24 <param name="width" type="integer" value="0" label="New width for nucleotides strings" help="Use 0 for single line out." />
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
25 </inputs>
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
26 <outputs>
3
4f66158f20f2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_formatter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
27 <data name="output" format="fasta" metadata_source="input" />
2
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
28 </outputs>
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
29 <tests>
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
30 <test>
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
31 <!-- Re-format a FASTA file into a single line -->
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
32 <param name="input" value="fasta_formatter1.fasta" />
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
33 <param name="width" value="0" />
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
34 <output name="output" file="fasta_formatter1.out" />
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
35 </test>
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
36 <test>
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
37 <!-- Re-format a FASTA file into multiple lines wrapping at 60 charactes -->
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
38 <param name="input" value="fasta_formatter1.fasta" />
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
39 <param name="width" value="60" />
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
40 <output name="output" file="fasta_formatter2.out" />
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
41 </test>
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
42 </tests>
3
4f66158f20f2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_formatter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
43 <help><![CDATA[
0
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
44 **What it does**
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
45
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
46 This tool re-formats a FASTA file, changing the width of the nucleotides lines.
2
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
47
0
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
48 **TIP:** Outputting a single line (with **width = 0**) can be useful for scripting (with **grep**, **awk**, and **perl**). Every odd line is a sequence identifier, and every even line is a nucleotides line.
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
49
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
50 --------
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
51
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
52 **Example**
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
53
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
54 Input FASTA file (each nucleotides line is 50 characters long)::
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
55
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
56 >Scaffold3648
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
57 AGGAATGATGACTACAATGATCAACTTAACCTATCTATTTAATTTAGTTC
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
58 CCTAATGTCAGGGACCTACCTGTTTTTGTTATGTTTGGGTTTTGTTGTTG
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
59 TTGTTTTTTTAATCTGAAGGTATTGTGCATTATATGACCTGTAATACACA
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
60 ATTAAAGTCAATTTTAATGAACATGTAGTAAAAACT
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
61 >Scaffold9299
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
62 CAGCATCTACATAATATGATCGCTATTAAACTTAAATCTCCTTGACGGAG
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
63 TCTTCGGTCATAACACAAACCCAGACCTACGTATATGACAAAGCTAATAG
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
64 aactggtctttacctTTAAGTTG
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
65
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
66
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
67 Output FASTA file (with width=80)::
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
68
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
69 >Scaffold3648
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
70 AGGAATGATGACTACAATGATCAACTTAACCTATCTATTTAATTTAGTTCCCTAATGTCAGGGACCTACCTGTTTTTGTT
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
71 ATGTTTGGGTTTTGTTGTTGTTGTTTTTTTAATCTGAAGGTATTGTGCATTATATGACCTGTAATACACAATTAAAGTCA
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
72 ATTTTAATGAACATGTAGTAAAAACT
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
73 >Scaffold9299
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
74 CAGCATCTACATAATATGATCGCTATTAAACTTAAATCTCCTTGACGGAGTCTTCGGTCATAACACAAACCCAGACCTAC
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
75 GTATATGACAAAGCTAATAGaactggtctttacctTTAAGTTG
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
76
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
77 Output FASTA file (with width=0 => single line)::
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
78
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
79 >Scaffold3648
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
80 AGGAATGATGACTACAATGATCAACTTAACCTATCTATTTAATTTAGTTCCCTAATGTCAGGGACCTACCTGTTTTTGTTATGTTTGGGTTTTGTTGTTGTTGTTTTTTTAATCTGAAGGTATTGTGCATTATATGACCTGTAATACACAATTAAAGTCAATTTTAATGAACATGTAGTAAAAACT
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
81 >Scaffold9299
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
82 CAGCATCTACATAATATGATCGCTATTAAACTTAAATCTCCTTGACGGAGTCTTCGGTCATAACACAAACCCAGACCTACGTATATGACAAAGCTAATAGaactggtctttacctTTAAGTTG
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
83
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
84 ------
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
85
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
86 This tool is based on `FASTX-toolkit`__ by Assaf Gordon.
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
87
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
88 .. __: http://hannonlab.cshl.edu/fastx_toolkit/
3
4f66158f20f2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_formatter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
89 ]]></help>
4f66158f20f2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_formatter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
90 <expand macro="citations" />
0
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
91 </tool>