annotate fastx_nucleotides_distribution.xml @ 2:9353010b95df draft

Uploaded tool help images.
author devteam
date Tue, 03 Jun 2014 15:09:10 -0400
parents 63d6e2daad48
children 21796f46e0ba
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
1 <tool id="cshl_fastx_nucleotides_distribution" version="1.0.0" name="Draw nucleotides distribution chart">
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
2 <description></description>
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
3 <requirements>
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
4 <requirement type="package" version="0.0.13">fastx_toolkit</requirement>
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
5 </requirements>
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
6 <command>fastx_nucleotide_distribution_graph.sh -t '$input.name' -i $input -o $output</command>
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
7
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
8 <inputs>
1
63d6e2daad48 Removed excess version attributes.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
9 <param format="txt" name="input" type="data" label="Statistics Text File" help="output of 'FASTX Statistics' tool" />
0
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
10 </inputs>
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
11
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
12 <outputs>
1
63d6e2daad48 Removed excess version attributes.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
13 <data format="png" name="output" metadata_source="input" />
0
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
14 </outputs>
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
15 <help>
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
16
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
17 **What it does**
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
18
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
19 Creates a stacked-histogram graph for the nucleotide distribution in the Solexa library.
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
20
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
21 .. class:: infomark
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
22
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
23 **TIP:** Use the **FASTQ Statistics** tool to generate the report file needed for this tool.
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
24
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
25 -----
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
26
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
27 **Output Examples**
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
28
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
29 The following chart clearly shows the barcode used at the 5'-end of the library: **GATCT**
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
30
2
9353010b95df Uploaded tool help images.
devteam
parents: 1
diff changeset
31 .. image:: fastq_nucleotides_distribution_1.png
0
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
32
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
33 In the following chart, one can almost 'read' the most abundant sequence by looking at the dominant values: **TGATA TCGTA TTGAT GACTG AA...**
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
34
2
9353010b95df Uploaded tool help images.
devteam
parents: 1
diff changeset
35 .. image:: fastq_nucleotides_distribution_2.png
0
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
36
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
37 The following chart shows a growing number of unknown (N) nucleotides towards later cycles (which might indicate a sequencing problem):
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
38
2
9353010b95df Uploaded tool help images.
devteam
parents: 1
diff changeset
39 .. image:: fastq_nucleotides_distribution_3.png
0
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
40
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
41 But most of the time, the chart will look rather random:
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
42
2
9353010b95df Uploaded tool help images.
devteam
parents: 1
diff changeset
43 .. image:: fastq_nucleotides_distribution_4.png
0
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
44
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
45 ------
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
46
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
47 This tool is based on `FASTX-toolkit`__ by Assaf Gordon.
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
48
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
49 .. __: http://hannonlab.cshl.edu/fastx_toolkit/
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
50
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
51 </help>
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
52 <!-- FASTQ-Nucleotides-Distribution is part of the FASTX-toolkit, by A.Gordon (gordon@cshl.edu) -->
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
53 </tool>