annotate galaxy-conf/ValueDistribution.xml @ 12:81d5b81fb3c2 draft

Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
author timpalpant
date Wed, 25 Apr 2012 16:53:48 -0400
parents b1952a90d4bf
children 3e477c7e0e73
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10
d063d22f4e80 Uploaded
timpalpant
parents:
diff changeset
1 <tool id="ValueDistribution" name="Compute the value distribution" version="1.0.0">
d063d22f4e80 Uploaded
timpalpant
parents:
diff changeset
2 <description>of a (Big)Wig file</description>
12
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
3 <command interpreter="sh">galaxyToolRunner.sh wigmath.ValueDistribution -i $input
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
4 #if str( $min ) != ''
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
5 --min $min
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
6 #end if
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
7
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
8 #if str( $max ) != ''
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
9 --max $max
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
10 #end if
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
11
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
12 -n $bins -o $output
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
13 </command>
10
d063d22f4e80 Uploaded
timpalpant
parents:
diff changeset
14 <inputs>
d063d22f4e80 Uploaded
timpalpant
parents:
diff changeset
15 <param format="bigwig,wig" name="input" type="data" label="(Big)Wig file" />
11
b1952a90d4bf Uploaded
timpalpant
parents: 10
diff changeset
16 <param name="min" type="float" optional="true" label="Minimum bin value (optional)" />
b1952a90d4bf Uploaded
timpalpant
parents: 10
diff changeset
17 <param name="max" type="float" optional="true" label="Maximum bin value (optional)" />
10
d063d22f4e80 Uploaded
timpalpant
parents:
diff changeset
18 <param name="bins" type="integer" value="40" label="Number of bins" />
d063d22f4e80 Uploaded
timpalpant
parents:
diff changeset
19 </inputs>
d063d22f4e80 Uploaded
timpalpant
parents:
diff changeset
20 <outputs>
d063d22f4e80 Uploaded
timpalpant
parents:
diff changeset
21 <data format="txt" name="output" />
d063d22f4e80 Uploaded
timpalpant
parents:
diff changeset
22 </outputs>
d063d22f4e80 Uploaded
timpalpant
parents:
diff changeset
23
d063d22f4e80 Uploaded
timpalpant
parents:
diff changeset
24 <help>
12
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
25
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
26 This tool computes a histogram of the values in a Wig file, as well as the moments of the distribution.
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
27
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
28 -----
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
29
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
30 **Syntax**
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
31
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
32 - **Input data** is the genomic data used to compute the histogram.
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
33 - **Minimum bin value** is the smallest bin. If unset, it is equal to the minimum value in the input data
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
34 - **Maximum bin value** is the largest bin. If unset, it is equal to the maximum value in the input data
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
35 - **Number of bins** is the number of bins to use. The bin size will be equal to (max - min) / (# bins).
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
36
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
37 -----
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
38
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
39 **Output**
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
40
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
41 The output is in 2-column tabular format, where the first column represents the lower edge of a bin inteval and the second column represents the number of values that fell in that bin. For example if the **minimum bin value** is 0, the **maximum bin value** is 0.3, and the **number of bins** is 3, then the following output might be produced ::
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
42
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
43 bin count
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
44 &lt;0 3
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
45 0 1
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
46 0.1 10
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
47 0.2 4
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
48 &gt;0.3 12
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
49
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
50 where there were 3 values in (-inf, 0), 1 value in [0, 0.1), 10 values in [0.1, 0.2), 4 values in [0.2, 0.3), and 12 values in [0.3, inf).
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
51
10
d063d22f4e80 Uploaded
timpalpant
parents:
diff changeset
52 </help>
d063d22f4e80 Uploaded
timpalpant
parents:
diff changeset
53 </tool>