annotate fasta_clipping_histogram.xml @ 0:78a7d28f2a15 draft

Uploaded
author idot
date Wed, 10 Jul 2013 06:13:48 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
1 <tool id="cshl_fasta_clipping_histogram" name="Length Distribution">
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
2 <description>chart</description>
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
3 <command>fasta_clipping_histogram.pl $input $outfile</command>
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
4
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
5 <inputs>
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
6 <param format="fasta" name="input" type="data" label="Library to analyze" />
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
7 </inputs>
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
8
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
9 <outputs>
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
10 <data format="png" name="outfile" metadata_source="input"
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
11 />
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
12 </outputs>
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
13 <help>
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
14
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
15 **What it does**
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
16
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
17 This tool creates a histogram image of sequence lengths distribution in a given fasta dataset file.
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
18
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
19 **TIP:** Use this tool after clipping your library (with **FASTX Clipper tool**), to visualize the clipping results.
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
20
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
21 -----
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
22
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
23 **Output Examples**
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
24
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
25 In the following library, most sequences are 24-mers to 27-mers.
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
26 This could indicate an abundance of endo-siRNAs (depending of course of what you've tried to sequence in the first place).
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
27
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
28 .. image:: ./static/fastx_icons/fasta_clipping_histogram_1.png
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
29
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
30
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
31 In the following library, most sequences are 19,22 or 23-mers.
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
32 This could indicate an abundance of miRNAs (depending of course of what you've tried to sequence in the first place).
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
33
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
34 .. image:: ./static/fastx_icons/fasta_clipping_histogram_2.png
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
35
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
36
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
37 -----
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
38
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
39
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
40 **Input Formats**
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
41
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
42 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::
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
43
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
44 >sequence1
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
45 AGTAGTAGGTGATGTAGAGAGAGAGAGAGTAG
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
46 >sequence2
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
47 GTGTGTGTGGGAAGTTGACACAGTA
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
48 >sequence3
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
49 CCTTGAGATTAACGCTAATCAAGTAAAC
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
50
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
51
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
52 If the sequences span over multiple lines::
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
53
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
54 >sequence1
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
55 CAGCATCTACATAATATGATCGCTATTAAACTTAAATCTCCTTGACGGAG
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
56 TCTTCGGTCATAACACAAACCCAGACCTACGTATATGACAAAGCTAATAG
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
57 aactggtctttacctTTAAGTTG
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
58
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
59 Use the **FASTA Width Formatter** tool to re-format the FASTA into a single-lined sequences::
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
60
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
61 >sequence1
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
62 CAGCATCTACATAATATGATCGCTATTAAACTTAAATCTCCTTGACGGAGTCTTCGGTCATAACACAAACCCAGACCTACGTATATGACAAAGCTAATAGaactggtctttacctTTAAGTTG
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
63
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
64
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
65 -----
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
66
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
67
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
68
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
69 **Multiplicity counts (a.k.a reads-count)**
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
70
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
71 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).
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
72
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
73 Example 1 - The following FASTA file *does not* have multiplicity counts::
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
74
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
75 >seq1
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
76 GGATCC
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
77 >seq2
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
78 GGTCATGGGTTTAAA
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
79 >seq3
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
80 GGGATATATCCCCACACACACACAC
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
81
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
82 Each sequence is counts as one, to produce the following chart:
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
83
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
84 .. image:: ./static/fastx_icons/fasta_clipping_histogram_3.png
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
85
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
86
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
87 Example 2 - The following FASTA file have multiplicity counts::
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
88
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
89 >seq1-2
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
90 GGATCC
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
91 >seq2-10
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
92 GGTCATGGGTTTAAA
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
93 >seq3-3
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
94 GGGATATATCCCCACACACACACAC
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
95
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
96 The first sequence counts as 2, the second as 10, the third as 3, to produce the following chart:
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
97
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
98 .. image:: ./static/fastx_icons/fasta_clipping_histogram_4.png
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
99
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
100 Use the **FASTA Collapser** tool to create FASTA files with multiplicity counts.
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
101
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
102 </help>
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
103 </tool>
78a7d28f2a15 Uploaded
idot
parents:
diff changeset
104 <!-- FASTA-Clipping-Histogram is part of the FASTX-toolkit, by A.Gordon (gordon@cshl.edu) -->