annotate windowSplitter.xml @ 1:477a0cfe6e6c

Corrected version string.
author devteam <devteam@galaxyproject.org>
date Thu, 10 Apr 2014 13:47:14 -0400
parents 4815516900d4
children 1fb384fb950e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
477a0cfe6e6c Corrected version string.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
1 <tool id="winSplitter" name="Make windows" version="1.0.0">
0
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
2 <description></description>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
3 <command interpreter="python">windowSplitter.py $input $size $out_file1 ${wintype.choice} ${wintype.offset} -l ${input.metadata.chromCol},${input.metadata.startCol},${input.metadata.endCol},${input.metadata.strandCol}</command>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
4 <inputs>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
5 <!--<param label="Genome" name="dbkey" type="genomebuild"/>-->
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
6 <param format="interval" name="input" type="data" label="Select data"/>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
7 <param name="size" size="10" type="integer" value="500" label="Window size"/>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
8 <conditional name="wintype">
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
9 <param name="choice" type="select" label="Make sliding windows?">
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
10 <option value="0" selected="true">No</option>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
11 <option value="1">Yes</option>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
12 </param>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
13 <when value="0">
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
14 <param name="offset" type="hidden" value="0" />
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
15 </when>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
16 <when value="1">
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
17 <param name="offset" size="10" type="integer" value="10" label="Offset size"/>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
18 </when>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
19 </conditional>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
20 </inputs>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
21 <outputs>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
22 <data format="interval" name="out_file1" metadata_source="input"/>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
23 </outputs>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
24 <tests>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
25 <test>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
26 <param name="input" value="4.bed"/>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
27 <param name="size" value="5000"/>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
28 <param name="choice" value="1"/>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
29 <param name="offset" value="4000"/>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
30 <output name="out_file1" file="4_windows.bed"/>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
31 </test>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
32 </tests>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
33 <help>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
34
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
35 .. class:: infomark
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
36
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
37 **What it does**
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
38
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
39 This tool splits the intervals in the input file into smaller intervals based on the specified window-size and window type.
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
40
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
41 -----
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
42
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
43 .. class:: warningmark
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
44
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
45 **Note**
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
46
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
47 The positions at the end of the input interval which do not fit into the last window or a new window of required size, will be omitted from the output.
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
48
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
49 -----
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
50
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
51 .. class:: infomark
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
52
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
53 **About formats**
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
54
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
55 **BED format** Browser Extensible Data format was designed at UCSC for displaying data tracks in the Genome Browser. It has three required fields and several additional optional ones:
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
56
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
57 The first three BED fields (required) are::
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
58
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
59 1. chrom - The name of the chromosome (e.g. chr1, chrY_random).
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
60 2. chromStart - The starting position in the chromosome. (The first base in a chromosome is numbered 0.)
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
61 3. chromEnd - The ending position in the chromosome, plus 1 (i.e., a half-open interval).
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
62
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
63 The additional BED fields (optional) are::
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
64
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
65 4. name - The name of the BED line.
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
66 5. score - A score between 0 and 1000.
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
67 6. strand - Defines the strand - either '+' or '-'.
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
68 7. thickStart - The starting position where the feature is drawn thickly at the Genome Browser.
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
69 8. thickEnd - The ending position where the feature is drawn thickly at the Genome Browser.
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
70 9. reserved - This should always be set to zero.
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
71 10. blockCount - The number of blocks (exons) in the BED line.
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
72 11. blockSizes - A comma-separated list of the block sizes. The number of items in this list should correspond to blockCount.
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
73 12. blockStarts - A comma-separated list of block starts. All of the blockStart positions should be calculated relative to chromStart. The number of items in this list should correspond to blockCount.
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
74 13. expCount - The number of experiments.
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
75 14. expIds - A comma-separated list of experiment ids. The number of items in this list should correspond to expCount.
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
76 15. expScores - A comma-separated list of experiment scores. All of the expScores should be relative to expIds. The number of items in this list should correspond to expCount.
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
77
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
78 -----
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
79
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
80 **Example**
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
81
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
82 - For the following dataset::
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
83
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
84 chr22 1000 4700 NM_174568 0 +
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
85
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
86 - running this tool with **Window size as 1000**, will return::
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
87
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
88 chr22 1000 2000 NM_174568 0 +
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
89 chr22 2000 3000 NM_174568 0 +
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
90 chr22 3000 4000 NM_174568 0 +
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
91
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
92 - running this tool to make **Sliding windows** of **size 1000** and **offset 500**, will return::
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
93
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
94 chr22 1000 2000 NM_174568 0 +
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
95 chr22 1500 2500 NM_174568 0 +
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
96 chr22 2000 3000 NM_174568 0 +
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
97 chr22 2500 3500 NM_174568 0 +
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
98 chr22 3000 4000 NM_174568 0 +
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
99 chr22 3500 4500 NM_174568 0 +
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
100
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
101 </help>
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
102
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
103
4815516900d4 Imported from capsule None
devteam
parents:
diff changeset
104 </tool>