annotate fasta_clipping_histogram.xml @ 0:f2ab5b44870d draft

Uploaded tool tarball.
author devteam
date Wed, 25 Sep 2013 14:55:11 -0400
parents
children f666895cbebd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
1 <tool id="cshl_fasta_clipping_histogram" name="Length Distribution" version="1.0.0">
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
2 <description>chart</description>
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
3 <requirements>
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
4 <requirement type="package" version="0.0.13">fastx_toolkit</requirement>
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
5 </requirements>
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
6 <command>fasta_clipping_histogram.pl $input $outfile</command>
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
7
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
8 <inputs>
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
9 <param format="fasta" name="input" type="data" label="Library to analyze" />
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
10 </inputs>
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
11
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
12 <outputs>
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
13 <data format="png" name="outfile" metadata_source="input" />
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
14 </outputs>
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
15 <help>
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
16
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
17 **What it does**
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
18
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
19 This tool creates a histogram image of sequence lengths distribution in a given fasta dataset file.
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
20
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
21 **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
22
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
23 -----
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
24
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
25 **Output Examples**
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
26
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
27 In the following library, most sequences are 24-mers to 27-mers.
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
28 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
29
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
30 .. image:: ${static_path}/fastx_icons/fasta_clipping_histogram_1.png
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
31
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
32
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
33 In the following library, most sequences are 19,22 or 23-mers.
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
34 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
35
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
36 .. image:: ${static_path}/fastx_icons/fasta_clipping_histogram_2.png
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
37
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
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
42 **Input Formats**
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
43
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
44 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
45
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
46 >sequence1
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
47 AGTAGTAGGTGATGTAGAGAGAGAGAGAGTAG
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
48 >sequence2
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
49 GTGTGTGTGGGAAGTTGACACAGTA
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
50 >sequence3
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
51 CCTTGAGATTAACGCTAATCAAGTAAAC
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 If the sequences span over multiple lines::
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
55
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
56 >sequence1
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
57 CAGCATCTACATAATATGATCGCTATTAAACTTAAATCTCCTTGACGGAG
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
58 TCTTCGGTCATAACACAAACCCAGACCTACGTATATGACAAAGCTAATAG
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
59 aactggtctttacctTTAAGTTG
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
60
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
61 Use the **FASTA Width Formatter** tool to re-format the FASTA into a single-lined sequences::
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
62
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
63 >sequence1
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
64 CAGCATCTACATAATATGATCGCTATTAAACTTAAATCTCCTTGACGGAGTCTTCGGTCATAACACAAACCCAGACCTACGTATATGACAAAGCTAATAGaactggtctttacctTTAAGTTG
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
65
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
66
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
67 -----
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
68
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
69
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
70
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
71 **Multiplicity counts (a.k.a reads-count)**
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
72
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
73 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
74
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
75 Example 1 - The following FASTA file *does not* have multiplicity counts::
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
76
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
77 >seq1
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
78 GGATCC
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
79 >seq2
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
80 GGTCATGGGTTTAAA
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
81 >seq3
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
82 GGGATATATCCCCACACACACACAC
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
83
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
84 Each sequence is counts as one, to produce the following chart:
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
85
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
86 .. image:: ${static_path}/fastx_icons/fasta_clipping_histogram_3.png
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
87
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
88
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
89 Example 2 - The following FASTA file have multiplicity counts::
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
90
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
91 >seq1-2
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
92 GGATCC
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
93 >seq2-10
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
94 GGTCATGGGTTTAAA
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
95 >seq3-3
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
96 GGGATATATCCCCACACACACACAC
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
97
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
98 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
99
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
100 .. image:: ${static_path}/fastx_icons/fasta_clipping_histogram_4.png
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
101
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
102 Use the **FASTA Collapser** tool to create FASTA files with multiplicity counts.
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
103
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
104 ------
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
105
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
106 This tool is based on `FASTX-toolkit`__ by Assaf Gordon.
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
107
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
108 .. __: http://hannonlab.cshl.edu/fastx_toolkit/
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
109
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
110 </help>
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
111 <!-- FASTA-Clipping-Histogram is part of the FASTX-toolkit, by A.Gordon (gordon@cshl.edu) -->
f2ab5b44870d Uploaded tool tarball.
devteam
parents:
diff changeset
112 </tool>