annotate tools/regVariation/windowSplitter.xml @ 2:c2a356708570

Uploaded
author xuebing
date Fri, 09 Mar 2012 19:45:42 -0500
parents 9071e359b9a3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
1 <tool id="winSplitter" name="Make windows">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description></description>
9071e359b9a3 Uploaded
xuebing
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>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 <!--<param label="Genome" name="dbkey" type="genomebuild"/>-->
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 <param format="interval" name="input" type="data" label="Select data"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 <param name="size" size="10" type="integer" value="500" label="Window size"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8 <conditional name="wintype">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 <param name="choice" type="select" label="Make sliding windows?">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 <option value="0" selected="true">No</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 <option value="1">Yes</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 <when value="0">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 <param name="offset" type="hidden" value="0" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 <when value="1">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 <param name="offset" size="10" type="integer" value="10" label="Offset size"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 </conditional>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 <data format="interval" name="out_file1" metadata_source="input"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 <param name="input" value="4.bed"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 <param name="size" value="5000"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 <param name="choice" value="1"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 <param name="offset" value="4000"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 <output name="out_file1" file="4_windows.bed"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 **What it does**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38
9071e359b9a3 Uploaded
xuebing
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.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43 .. class:: warningmark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45 **Note**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46
9071e359b9a3 Uploaded
xuebing
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.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53 **About formats**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54
9071e359b9a3 Uploaded
xuebing
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:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57 The first three BED fields (required) are::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 1. chrom - The name of the chromosome (e.g. chr1, chrY_random).
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60 2. chromStart - The starting position in the chromosome. (The first base in a chromosome is numbered 0.)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61 3. chromEnd - The ending position in the chromosome, plus 1 (i.e., a half-open interval).
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63 The additional BED fields (optional) are::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65 4. name - The name of the BED line.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66 5. score - A score between 0 and 1000.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67 6. strand - Defines the strand - either '+' or '-'.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68 7. thickStart - The starting position where the feature is drawn thickly at the Genome Browser.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69 8. thickEnd - The ending position where the feature is drawn thickly at the Genome Browser.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
70 9. reserved - This should always be set to zero.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
71 10. blockCount - The number of blocks (exons) in the BED line.
9071e359b9a3 Uploaded
xuebing
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.
9071e359b9a3 Uploaded
xuebing
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.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
74 13. expCount - The number of experiments.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
75 14. expIds - A comma-separated list of experiment ids. The number of items in this list should correspond to expCount.
9071e359b9a3 Uploaded
xuebing
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.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
77
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
78 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
79
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
80 **Example**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
81
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
82 - For the following dataset::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
83
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
84 chr22 1000 4700 NM_174568 0 +
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
85
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
86 - running this tool with **Window size as 1000**, will return::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
87
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
88 chr22 1000 2000 NM_174568 0 +
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
89 chr22 2000 3000 NM_174568 0 +
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
90 chr22 3000 4000 NM_174568 0 +
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
91
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
92 - running this tool to make **Sliding windows** of **size 1000** and **offset 500**, will return::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
93
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
94 chr22 1000 2000 NM_174568 0 +
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
95 chr22 1500 2500 NM_174568 0 +
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
96 chr22 2000 3000 NM_174568 0 +
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
97 chr22 2500 3500 NM_174568 0 +
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
98 chr22 3000 4000 NM_174568 0 +
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
99 chr22 3500 4500 NM_174568 0 +
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
100
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
101 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
102
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
103
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
104 </tool>