annotate galaxy-conf/MatrixAligner.xml @ 25:b43c420a6135 draft default tip

Incorporate fix: https://github.com/timpalpant/java-genomics-toolkit/commit/9a6c61b7c6b8d85a1cd3f595eed657a537b85dc9
author timpalpant
date Sat, 09 Feb 2019 14:02:24 -0500
parents 9d56b5b85740
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
1 <tool id="MatrixAligner" name="Align values in a matrix" version="1.0.0">
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
2 <description>for a heatmap</description>
25
b43c420a6135 Incorporate fix: https://github.com/timpalpant/java-genomics-toolkit/commit/9a6c61b7c6b8d85a1cd3f595eed657a537b85dc9
timpalpant
parents: 20
diff changeset
3 <command interpreter="bash">galaxyToolRunner.sh visualization.MatrixAligner -i $input -l $loci -m $M -o $output</command>
20
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
4 <inputs>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
5 <param format="wig,bigwig" name="input" type="data" label="Sequencing data" />
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
6 <param format="bed" name="loci" type="data" label="List of intervals (with alignment points)" />
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
7 <param type="integer" name="M" value="4000" label="Maximum row length" />
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
8 </inputs>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
9 <outputs>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
10 <data format="tabular" name="output" />
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
11 </outputs>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
12 <!-- TODO:<tests>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
13 <test>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
14 <param name="input" value="test.wig"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
15 <param name="loci" value="test.bed"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
16 <param name="M" value="4000"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
17 <output name="output" file="matrixAligner.output"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
18 </test>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
19 <test>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
20 <param name="input" value="test.bw"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
21 <param name="loci" value="test.bed"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
22 <param name="M" value="4000"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
23 <output name="output" file="matrixAligner.output"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
24 </test>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
25 <test>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
26 <param name="input" value="test.wig"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
27 <param name="loci" value="test2.bed"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
28 <param name="M" value="4000"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
29 <output name="output" file="matrixAligner.output2"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
30 </test>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
31 <test>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
32 <param name="input" value="test.bw"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
33 <param name="loci" value="test2.bed"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
34 <param name="M" value="4000"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
35 <output name="output" file="matrixAligner.output2"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
36 </test>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
37 <test>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
38 <param name="input" value="test.wig"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
39 <param name="loci" value="test3.bed"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
40 <param name="M" value="4000"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
41 <output name="output" file="matrixAligner.output3"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
42 </test>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
43 <test>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
44 <param name="input" value="test.bw"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
45 <param name="loci" value="test3.bed"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
46 <param name="M" value="4000"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
47 <output name="output" file="matrixAligner.output3"/>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
48 </test>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
49 </tests>-->
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
50
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
51 <help>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
52
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
53 This tool aligns sequencing data into a rectangular matrix for creating a heatmap with matrix2png. Data from each interval is lined up on the specified alignment point (column 5 in the Bed file), and flipped if on the - strand so that all intervals are 5'-to-3' from left-to-right.
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
54
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
55 Intervals with alignment points must be provided in the following extended Bed format ::
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
56
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
57 chr low high id alignment strand
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
58
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
59 The heatmap is created by taking each interval in the **List of Intervals**, retrieving the data for that interval from the Wig file, and adding it as a new row in the matrix. Intervals are processed in their original order.
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
60
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
61 -----
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
62
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
63 **Syntax**
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
64
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
65 - **Sequencing data** is the genomic data used to create the matrix
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
66 - **List of intervals** is a list of intervals in Bed format with alignment points
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
67 - **Maximum row length** is the maximum allowed width of the matrix. If aligned intervals extend outside of this width, they will be truncated.
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
68
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
69 -----
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
70
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
71 .. class:: infomark
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
72
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
73 **TIP:** If your dataset does not appear in the pulldown menu, it means that it is not in Wig or BigWig format. Use "edit attributes" to set the correct format if it was not detected correctly.
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
74
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
75 .. class:: warningmark
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
76
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
77 Large heatmap matrices may require a long time to generate in Galaxy because it validates that the output is in correct tab-delimited format. To reduce the size of an MxN matrix with large M, rows (N) can be truncated using the maximum row length parameter. Rows are truncated from the alignment point (symmetrically) if possible, or as nearly symmetrically as possible.
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
78
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
79 </help>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
80 </tool>