annotate fasta_clipping_histogram.xml @ 5:cf0a5c96c7f8 draft default tip

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