annotate galaxy-conf/MatrixAligner.xml @ 15:3e477c7e0e73 draft

Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
author timpalpant
date Sat, 09 Jun 2012 16:03:59 -0400
parents 81d5b81fb3c2
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
1 <tool id="MatrixAligner" name="Align values in a matrix" version="1.0.0">
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
2 <description>for a heatmap</description>
12
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
diff changeset
3 <command interpreter="sh">galaxyToolRunner.sh visualization.MatrixAligner -i $input -l $loci -m $M -o $output</command>
4
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
4 <inputs>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
5 <param format="wig,bigwig" name="input" type="data" label="Sequencing data" />
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
6 <param format="bed" name="loci" type="data" label="List of intervals (with alignment points)" />
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
7 <param type="integer" name="M" value="4000" label="Maximum row length" />
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
8 </inputs>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
9 <outputs>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
10 <data format="tabular" name="output" />
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
11 </outputs>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
12 <!-- TODO:<tests>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
13 <test>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
14 <param name="input" value="test.wig"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
15 <param name="loci" value="test.bed"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
16 <param name="M" value="4000"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
17 <output name="output" file="matrixAligner.output"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
18 </test>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
19 <test>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
20 <param name="input" value="test.bw"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
21 <param name="loci" value="test.bed"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
22 <param name="M" value="4000"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
23 <output name="output" file="matrixAligner.output"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
24 </test>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
25 <test>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
26 <param name="input" value="test.wig"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
27 <param name="loci" value="test2.bed"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
28 <param name="M" value="4000"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
29 <output name="output" file="matrixAligner.output2"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
30 </test>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
31 <test>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
32 <param name="input" value="test.bw"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
33 <param name="loci" value="test2.bed"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
34 <param name="M" value="4000"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
35 <output name="output" file="matrixAligner.output2"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
36 </test>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
37 <test>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
38 <param name="input" value="test.wig"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
39 <param name="loci" value="test3.bed"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
40 <param name="M" value="4000"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
41 <output name="output" file="matrixAligner.output3"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
42 </test>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
43 <test>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
44 <param name="input" value="test.bw"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
45 <param name="loci" value="test3.bed"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
46 <param name="M" value="4000"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
47 <output name="output" file="matrixAligner.output3"/>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
48 </test>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
49 </tests>-->
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
50
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
51 <help>
12
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
diff changeset
52
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
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.
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
diff changeset
54
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
diff changeset
55 Intervals with alignment points must be provided in the following extended Bed format ::
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
diff changeset
56
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
diff changeset
57 chr low high id alignment strand
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
diff changeset
58
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
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.
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
diff changeset
60
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
diff changeset
61 -----
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
diff changeset
62
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
diff changeset
63 **Syntax**
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
diff changeset
64
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
diff changeset
65 - **Sequencing data** is the genomic data used to create the matrix
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
diff changeset
66 - **List of intervals** is a list of intervals in Bed format with alignment points
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
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.
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
diff changeset
68
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
diff changeset
69 -----
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
diff changeset
70
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
diff changeset
71 .. class:: infomark
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
diff changeset
72
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
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.
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
diff changeset
74
4
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
75 .. class:: warningmark
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
76
12
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
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.
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 4
diff changeset
78
4
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
79 </help>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
80 </tool>