annotate fasta_clipping_histogram.xml @ 2:9db07fd39f85 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
author iuc
date Tue, 08 May 2018 12:53:35 -0400
parents f666895cbebd
children 8889eb864cef
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
1 <tool id="cshl_fasta_clipping_histogram" name="Length Distribution" version="1.0.1">
1
f666895cbebd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
2 <description>chart</description>
2
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
3 <macros>
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
4 <import>macros.xml</import>
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
5 </macros>
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
6 <expand macro="requirements">
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
7 <requirement type="package" version="1.49">perl-gdgraph</requirement>
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
8 </expand>
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
9 <command detect_errors="exit_code"><![CDATA[
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
10 fasta_clipping_histogram.pl
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
11 '$input'
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
12 '$outfile'
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
13 ]]></command>
1
f666895cbebd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
14
f666895cbebd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
15 <inputs>
2
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
16 <expand macro="fasta_input" />
1
f666895cbebd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
17 </inputs>
0
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
18
1
f666895cbebd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
19 <outputs>
2
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
20 <data name="outfile" format="png" metadata_source="input" />
1
f666895cbebd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
21 </outputs>
f666895cbebd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
22 <tests>
2
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
23 <test>
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
24 <param name="input" value="fasta_clipping_histogram-in1.fa" />
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
25 <output name="outfile" file="fasta_clipping_histogram-out1.png" compare="sim_size" delta="512" />
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
26 </test>
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
27 <test>
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
28 <param name="input" value="fasta_clipping_histogram-in2.fa" />
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
29 <output name="outfile" file="fasta_clipping_histogram-out2.png" compare="sim_size" delta="512" />
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
30 </test>
1
f666895cbebd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
31 </tests>
2
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
32 <help><![CDATA[
0
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
33 **What it does**
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
34
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
35 This tool creates a histogram image of sequence lengths distribution in a given fasta dataset file.
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
36
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
37 **TIP:** Use this tool after clipping your library (with **FASTX Clipper tool**), to visualize the clipping results.
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
38
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
39 -----
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
40
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
41 **Output Examples**
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
42
1
f666895cbebd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
43 In the following library, most sequences are 24-mers to 27-mers.
0
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
44 This could indicate an abundance of endo-siRNAs (depending of course of what you've tried to sequence in the first place).
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
45
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
46 .. image:: ${static_path}/fastx_icons/fasta_clipping_histogram_1.png
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
47
1
f666895cbebd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
48 In the following library, most sequences are 19,22 or 23-mers.
0
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
49 This could indicate an abundance of miRNAs (depending of course of what you've tried to sequence in the first place).
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
50
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
51 .. image:: ${static_path}/fastx_icons/fasta_clipping_histogram_2.png
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
52
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
53 -----
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
54
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
55 **Input Formats**
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
56
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
57 This tool accepts short-reads FASTA files. The reads don't have to be short, but they do have to be on a single line, like so::
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
58
2
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
59 >sequence1
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
60 AGTAGTAGGTGATGTAGAGAGAGAGAGAGTAG
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
61 >sequence2
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
62 GTGTGTGTGGGAAGTTGACACAGTA
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
63 >sequence3
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
64 CCTTGAGATTAACGCTAATCAAGTAAAC
0
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
65
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
66 If the sequences span over multiple lines::
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
67
2
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
68 >sequence1
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
69 CAGCATCTACATAATATGATCGCTATTAAACTTAAATCTCCTTGACGGAG
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
70 TCTTCGGTCATAACACAAACCCAGACCTACGTATATGACAAAGCTAATAG
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
71 aactggtctttacctTTAAGTTG
0
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
72
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
73 Use the **FASTA Width Formatter** tool to re-format the FASTA into a single-lined sequences::
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
74
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
75 >sequence1
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
76 CAGCATCTACATAATATGATCGCTATTAAACTTAAATCTCCTTGACGGAGTCTTCGGTCATAACACAAACCCAGACCTACGTATATGACAAAGCTAATAGaactggtctttacctTTAAGTTG
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
77
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
78 -----
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
79
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
80 **Multiplicity counts (a.k.a reads-count)**
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
81
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
82 If the sequence identifier (the text after the '>') contains a dash and a number, it is treated as a multiplicity count value (i.e. how many times that individual sequence repeated in the original FASTA file, before collapsing).
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
83
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
84 Example 1 - The following FASTA file *does not* have multiplicity counts::
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
85
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
86 >seq1
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
87 GGATCC
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
88 >seq2
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
89 GGTCATGGGTTTAAA
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
90 >seq3
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
91 GGGATATATCCCCACACACACACAC
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
92
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
93 Each sequence is counts as one, to produce the following chart:
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
94
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
95 .. image:: ${static_path}/fastx_icons/fasta_clipping_histogram_3.png
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
96
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
97 Example 2 - The following FASTA file have multiplicity counts::
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
98
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
99 >seq1-2
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
100 GGATCC
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
101 >seq2-10
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
102 GGTCATGGGTTTAAA
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
103 >seq3-3
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
104 GGGATATATCCCCACACACACACAC
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
105
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
106 The first sequence counts as 2, the second as 10, the third as 3, to produce the following chart:
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
107
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
108 .. image:: ${static_path}/fastx_icons/fasta_clipping_histogram_4.png
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
109
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
110 Use the **FASTA Collapser** tool to create FASTA files with multiplicity counts.
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
111
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
112 ------
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
113
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
114 This tool is based on `FASTX-toolkit`__ by Assaf Gordon.
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
115
2
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
116 .. __: http://hannonlab.cshl.edu/fastx_toolkit/
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
117 ]]></help>
9db07fd39f85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 1
diff changeset
118 <expand macro="citations" />
1
f666895cbebd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fasta_clipping_histogram commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
119 </tool>