annotate galaxy-conf/GreedyCaller.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
4
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
1 <tool id="CallNukes" name="Call Nucleosomes" version="1.0.0">
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
2 <description>in an MNase experiment</description>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
3 <command interpreter="sh">galaxyToolRunner.sh nucleosomes.GreedyCaller -d $dyads -s $smoothed -n $N -o $output</command>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
4 <inputs>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
5 <param name="dyads" type="data" format="bigwig,wig" label="Dyad counts" />
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
6 <param name="smoothed" type="data" format="bigwig,wig" label="Smoothed dyad counts" />
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
7 <param name="N" type="integer" value="147" optional="true" label="Assumed nucleosome size" />
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
8 </inputs>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
9 <outputs>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
10 <data name="output" format="tabular" />
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
11 </outputs>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
12
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
13 <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
14
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
15 Stereotypic nucleosome positions are identified from dyad density maps using an approach similar to the previously reported greedy algorithm in GeneTrack_ (Albert, et al. 2008). Nucleosome calls are identified at peak maxima (p) in the smoothed dyad density map, and then excluded in the surrounding window [p–N, p+N], where N is the assumed nucleosome size in base pairs. This process is continued until all possible sterically hindered nucleosome positions are identified.
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
16
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
17 .. _GeneTrack: http://atlas.bx.psu.edu/genetrack/docs/genetrack.html
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
18
4
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
19 .. class:: warningmark
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
20
12
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
21 This tool requires dyad counts and smoothed dyad counts in Wig or BigWig format. Smoothed dyad counts can be generated from dyad counts using the WigMath -> Gaussian smooth tool.
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
22
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
23 -----
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
24
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
25 **Syntax**
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
26
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
27 - **Dyad counts** is the relative number of nucleosomes positioned at each base pair.
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
28 - **Smoothed dyad counts** should correspond to a smoothed version of the **Dyad counts**
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
29 - **Assumed nucleosome size** is the window size used while identifying maxima to restrict overlapping calls.
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
30
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
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
33 **Output**
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
34
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
35 The output format has 10 columns defined as follows
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 - 1. **Chromosome:** the chromosome of this nucleosome call
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
38 - 2. **Start:** the lower coordinate of the call window, equal to the dyad position - N/2
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
39 - 3. **Stop:** the higher coordinate of the call window, equal to the dyad position + N/2
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
40 - 4. **Length:** the window size (N) of the nucleosome call, equal to the value specified when the tool was run
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
41 - 5. **Length standard deviation:** the standard deviation of the nucleosome call length (equal to 0 because it is not currently calculated)
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
42 - 6. **Dyad:** the location of the peak maximum (p) in the smoothed dyad density data
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
43 - 7. **Dyad standard deviation:** the standard deviation of dyad density around the dyad mean in the dyad counts data
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
44 - 8. **Conditional position:** the probability that a nucleosome is at this exact dyad location as opposed to anywhere else in the nucleosome call window [p-N/2, p+N/2]
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
45 - 9. **Dyad mean:** the mean of the dyad counts in the window [p-N/2, p+N/2]
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
46 - 10. **Occupancy:** the sum of the dyad counts in the window [p-N/2, p+N/2]
81d5b81fb3c2 Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
timpalpant
parents: 11
diff changeset
47
4
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
48 </help>
4b32ed5d4a1b Uploaded
timpalpant
parents:
diff changeset
49 </tool>