annotate chromatrat.xml @ 6:e943b5e80fec

Uploaded
author cmmt
date Mon, 23 Jan 2012 05:26:07 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
1 <tool id="chromatra_t" name="Chromatra T" version="1.0.0">
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
2 <description>for visualizing genome-wide chromatin modifications</description>
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
3 <command interpreter="python">chromatrat.py $gffinput $feainput $imgformat $stepwidth '$classboundaries' $upstreamstretch $maxx $tickspacing '$title' $output</command>
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
4 <inputs>
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
5 <param name="gffinput" format="gff" type="data" label="Normalized enrichment scores"/>
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
6 <param name="feainput" format="tabular" type="data" label="Feature descriptions"/>
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
7 <param name="imgformat" type="select" label="Image format">
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
8 <option value="svg" selected="true">svg</option>
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
9 <option value="png">png</option>
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
10 <option value="pdf">pdf</option>
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
11 </param>
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
12 <param name="stepwidth" type="integer" value="150" min="1" label="Bin size in bp" />
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
13 <param name="classboundaries" type="text" value="1, 4, 16, 50, 200" size="30" label="Class boundaries" />
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
14 <param name="upstreamstretch" type="integer" value="450" min="0" label="Number of bp upstream of feature start to be plotted" />
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
15 <param name="maxx" type="integer" value="5000" label="Max bp to be plotted along x-coordinate. (Enter -1 for max feature length)"/>
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
16 <param name="tickspacing" type="integer" value="1000" label="Tick spacing along x-coordinate" />
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
17 <param name="title" type="text" value="" size="30" label="Plot title" />
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
18 </inputs>
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
19 <outputs>
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
20 <data format="svg" name="output">
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
21 <change_format>
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
22 <when input="imgformat" value="png" format="png" />
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
23 <when input="imgformat" value="pdf" format="pdf" />
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
24 <when input="imgformat" value="svg" format="svg" />
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
25 </change_format>
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
26 </data>
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
27 </outputs>
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
28
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
29 <requirements>
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
30 <requirement type="python-module">matplotlib</requirement>
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
31 </requirements>
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
32
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
33 <help>
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
34 CHROMATRA T visualizes the enrichment of chromatin modification across genomic features (e.g. all transcripts of a genome) in an unbiased way by accounting for feature length.
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
35 Furthermore, CHROMATRA T groups features based on a second characteristic (e.g. transcriptional frequency of transcripts).
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
36
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
37 -----
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
38
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
39 .. class:: infomark
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
40
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
41 **Normalized enrichment scores**
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
42
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
43 Enrichment scores must be provided in *GGFv3* format.
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
44
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
45 .. class:: infomark
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
46
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
47 **Feature descriptions**
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
48
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
49 Features must be provided in a *TAB*-delimited format in this order:
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
50
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
51 -1. feature name
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
52
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
53 -2. chromosome number
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
54
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
55 -3. strand
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
56
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
57 -4. feature start
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
58
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
59 -5. feature end
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
60
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
61 -6. feature attribute
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
62
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
63 .. class:: infomark
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
64
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
65 **Class boundaries**
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
66
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
67 Comma-seperated values spanning the *entire* numerical range of feature attributes. Values are interpreted as upper limits of the classes.
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
68 Example: Assuming the feature attribute to be transcriptional frequency of transcripts and the attribute value range to be 0.1 up to 85.3 mRNA/h, a proper class boundary specification might look like: "1, 5, 10, 100".
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
69 This would partition the range of transcriptional frequencies into 4 classes such that *class 1* would contain all transcripts less or equal to 1 mRNA/h, *class 2* all greater than 1 and less or equal to 5 mRNA/h, *class 3* all greater than 5 and less or equal 10 mRNA/h, and *class 4* all transcripts greater than 10 (and less than 100) mRNA/h.
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
70
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
71 .. class:: warningmark
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
72
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
73 The last boundary value must be greater or equal to the largest attribute value.
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
74 </help>
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
75
e943b5e80fec Uploaded
cmmt
parents:
diff changeset
76 </tool>