annotate fastx_nucleotides_distribution.xml @ 6:b6b54ba71bd8 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit fd099d17eceaa319fbfe429f4725328d88b18c9f
author iuc
date Thu, 10 Aug 2023 06:54:04 +0000
parents ad116ae3f4d9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
b6b54ba71bd8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit fd099d17eceaa319fbfe429f4725328d88b18c9f
iuc
parents: 5
diff changeset
1 <tool id="cshl_fastx_nucleotides_distribution" version="1.0.1+galaxy@VERSION_SUFFIX@" profile="22.05" name="Draw nucleotides distribution chart">
4
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
2 <description></description>
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
3 <macros>
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
4 <import>macros.xml</import>
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
5 </macros>
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
6 <expand macro="requirements" />
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
8 fastx_nucleotide_distribution_graph.sh
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
9 -t '$input.name'
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
10 -i '$input'
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
11 -o '$output'
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
12 ]]></command>
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
13 <inputs>
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
14 <param name="input" type="data" format="txt" label="Statistics text file" help="Output of 'FASTX Statistics' tool" />
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
15 </inputs>
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
16 <outputs>
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
17 <data name="output" format="png" metadata_source="input" />
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
18 </outputs>
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
19 <tests>
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
20 <test>
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
21 <param name="input" value="fastx_nucleotides_distribution-in1.txt" />
5
ad116ae3f4d9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit 4c002e52261da2e7609735883d91fa1610ce6ce7"
iuc
parents: 4
diff changeset
22 <output name="output" file="fastx_nucleotides_distribution-out1.png" compare="sim_size" delta="4000" />
4
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
23 </test>
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
24 </tests>
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
25 <help><![CDATA[
0
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
26 **What it does**
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
27
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
28 Creates a stacked-histogram graph for the nucleotide distribution in the Solexa library.
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
29
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
30 .. class:: infomark
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
31
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
32 **TIP:** Use the **FASTQ Statistics** tool to generate the report file needed for this tool.
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
33
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
34 -----
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
35
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
36 **Output Examples**
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
37
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
38 The following chart clearly shows the barcode used at the 5'-end of the library: **GATCT**
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
39
2
9353010b95df Uploaded tool help images.
devteam
parents: 1
diff changeset
40 .. image:: fastq_nucleotides_distribution_1.png
4
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
41
0
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
42 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
43
2
9353010b95df Uploaded tool help images.
devteam
parents: 1
diff changeset
44 .. image:: fastq_nucleotides_distribution_2.png
0
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
45
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
46 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
47
2
9353010b95df Uploaded tool help images.
devteam
parents: 1
diff changeset
48 .. image:: fastq_nucleotides_distribution_3.png
0
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
49
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
50 But most of the time, the chart will look rather random:
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
51
2
9353010b95df Uploaded tool help images.
devteam
parents: 1
diff changeset
52 .. image:: fastq_nucleotides_distribution_4.png
0
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
53
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
54 ------
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
55
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
56 This tool is based on `FASTX-toolkit`__ by Assaf Gordon.
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
57
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
58 .. __: http://hannonlab.cshl.edu/fastx_toolkit/
4
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
59 ]]></help>
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
60 <expand macro="citations" />
21796f46e0ba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastx_nucleotides_distribution commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
61 <!-- FASTQ-Nucleotides-Distribution is part of the FASTX-toolkit, by A.Gordon (gordon@cshl.edu) -->
0
bcc5424a4a3c Uploaded tool tarball.
devteam
parents:
diff changeset
62 </tool>