annotate fasta_formatter.xml @ 2:61469a8970cd draft

planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
author devteam
date Tue, 13 Oct 2015 12:39:03 -0400
parents 2cbdd2fc365b
children 4f66158f20f2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
1 <tool id="cshl_fasta_formatter" version="1.0.0" name="FASTA Width">
2
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
2 <description>formatter</description>
0
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
3 <requirements>
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
4 <requirement type="package" version="0.0.13">fastx_toolkit</requirement>
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
5 </requirements>
2
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
6 <!--
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
7 Note:
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
8 fasta_formatter also has a tabular output mode (-t),
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
9 but Galaxy already contains such a tool, so no need
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
10 to offer the user a duplicated tool.
0
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
11
2
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
12 So this XML tool only changes the width (line-wrapping) of a
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
13 FASTA file.
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
14 -->
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
15 <command>
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
16 <![CDATA[
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
17 zcat -f < '$input' | fasta_formatter -w $width -o '$output'
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
18 ]]>
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
19 </command>
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
20 <inputs>
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
21 <param format="fasta" name="input" type="data" label="Library to re-format" />
0
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
22
2
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
23 <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
24 </inputs>
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
25 <outputs>
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
26 <data format="fasta" name="output" metadata_source="input" />
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
27 </outputs>
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
28 <tests>
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
29 <test>
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
30 <!-- Re-format a FASTA file into a single line -->
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
31 <param name="input" value="fasta_formatter1.fasta" />
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
32 <param name="width" value="0" />
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
33 <output name="output" file="fasta_formatter1.out" />
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
34 </test>
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
35 <test>
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
36 <!-- Re-format a FASTA file into multiple lines wrapping at 60 charactes -->
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
37 <param name="input" value="fasta_formatter1.fasta" />
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
38 <param name="width" value="60" />
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
39 <output name="output" file="fasta_formatter2.out" />
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
40 </test>
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
41 </tests>
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
42 <help>
0
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
43 **What it does**
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
44
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
45 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
46
0
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
47 **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
48
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 **Example**
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
52
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
53 Input FASTA file (each nucleotides line is 50 characters long)::
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
54
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
55 >Scaffold3648
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
56 AGGAATGATGACTACAATGATCAACTTAACCTATCTATTTAATTTAGTTC
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
57 CCTAATGTCAGGGACCTACCTGTTTTTGTTATGTTTGGGTTTTGTTGTTG
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
58 TTGTTTTTTTAATCTGAAGGTATTGTGCATTATATGACCTGTAATACACA
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
59 ATTAAAGTCAATTTTAATGAACATGTAGTAAAAACT
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
60 >Scaffold9299
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
61 CAGCATCTACATAATATGATCGCTATTAAACTTAAATCTCCTTGACGGAG
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
62 TCTTCGGTCATAACACAAACCCAGACCTACGTATATGACAAAGCTAATAG
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
63 aactggtctttacctTTAAGTTG
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
64
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
65
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
66 Output FASTA file (with width=80)::
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
67
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
68 >Scaffold3648
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
69 AGGAATGATGACTACAATGATCAACTTAACCTATCTATTTAATTTAGTTCCCTAATGTCAGGGACCTACCTGTTTTTGTT
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
70 ATGTTTGGGTTTTGTTGTTGTTGTTTTTTTAATCTGAAGGTATTGTGCATTATATGACCTGTAATACACAATTAAAGTCA
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
71 ATTTTAATGAACATGTAGTAAAAACT
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
72 >Scaffold9299
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
73 CAGCATCTACATAATATGATCGCTATTAAACTTAAATCTCCTTGACGGAGTCTTCGGTCATAACACAAACCCAGACCTAC
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
74 GTATATGACAAAGCTAATAGaactggtctttacctTTAAGTTG
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
75
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
76 Output FASTA file (with width=0 => single line)::
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
77
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
78 >Scaffold3648
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
79 AGGAATGATGACTACAATGATCAACTTAACCTATCTATTTAATTTAGTTCCCTAATGTCAGGGACCTACCTGTTTTTGTTATGTTTGGGTTTTGTTGTTGTTGTTTTTTTAATCTGAAGGTATTGTGCATTATATGACCTGTAATACACAATTAAAGTCAATTTTAATGAACATGTAGTAAAAACT
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
80 >Scaffold9299
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
81 CAGCATCTACATAATATGATCGCTATTAAACTTAAATCTCCTTGACGGAGTCTTCGGTCATAACACAAACCCAGACCTACGTATATGACAAAGCTAATAGaactggtctttacctTTAAGTTG
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
82
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 This tool is based on `FASTX-toolkit`__ by Assaf Gordon.
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
86
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
87 .. __: http://hannonlab.cshl.edu/fastx_toolkit/
2
61469a8970cd planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
88 </help>
0
f7d3b87e9851 Uploaded tool tarball.
devteam
parents:
diff changeset
89 </tool>