annotate gemini_annotate.xml @ 2:93bb0cfacefb draft

Uploaded
author iuc
date Mon, 12 Jan 2015 15:31:50 -0500
parents 720cbfb4190d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
1 <tool id="gemini_@BINARY@" name="GEMINI @BINARY@" version="@VERSION@.0">
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
2 <description>adding your own custom annotations</description>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
3 <expand macro="requirements" />
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
4 <expand macro="version_command" />
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
5 <macros>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
6 <import>gemini_macros.xml</import>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
7 <token name="@BINARY@">annotate</token>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
8 </macros>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
9 <command>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
10 <![CDATA[
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
11
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
12 bgzip -c $annotate_source > tabixed.gz;
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
13 tabix -p bed tabixed.gz;
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
14
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
15 gemini @BINARY@
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
16 -f tabixed.gz
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
17 -c $column_name
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
18 -a $a.a_selector
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
19 #if $a.a_selector == 'extract':
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
20 -t $a.column_type
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
21 -e $a.column_extracts
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
22 -o $a.operation
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
23 #end if
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
24
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
25 "${ infile }"
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
26 > "${ outfile }"
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
27 ]]>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
28
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
29 </command>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
30 <expand macro="stdio" />
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
31 <inputs>
2
93bb0cfacefb Uploaded
iuc
parents: 0
diff changeset
32 <expand macro="infile" />
0
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
33 <param name="annotate_source" type="data" format="bed" label="File containing the annotations in BED format" help="(-f)"/>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
34
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
35 <param name="column_name" size="20" type="text" value=""
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
36 label="The name of the column to be added to the variant table" help="(-c)">
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
37 <sanitizer invalid_char=" ">
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
38 <valid initial="string.letters,string.digits">
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
39 <add value="_" />
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
40 </valid>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
41 </sanitizer>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
42 </param>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
43 <conditional name="a">
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
44 <param name="a_selector" type="select" label="How should the annotation file be used?" help="(-a)">
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
45 <option value="boolean">Did a variant overlap a region or not? (boolean)</option>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
46 <option value="count">How many regions did a variant overlap? (count)</option>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
47 <option value="extract" selected="True">Extract specific values from a BED file. (extract)</option>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
48 </param>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
49 <when value="extract">
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
50
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
51 <param name="column_extracts" label="Column to extract information from for list annotations"
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
52 type="data_column" data_ref="annotate_source" force_select="true" help="(-e)"/>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
53
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
54
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
55 <param name="column_type" type="select" label="What data type(s) should be used to represent the new values in the database?"
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
56 help="(-t)">
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
57 <option value="float">Decimal precision number (float)</option>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
58 <option value="integer">Integer number (integer)</option>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
59 <option value="text">Text columns such as “valid”, “yes” (text)</option>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
60 </param>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
61
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
62 <param name="operation" type="select" label="Operation to apply to the extract column values ..."
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
63 help="in the event that a variant overlaps multiple annotations in your annotation file. (-o)">
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
64 <option value="mean">Compute the average of the (numeric) values</option>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
65 <option value="median">Compute the median of the (numeric) values</option>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
66 <option value="mix">Compute the minimum of the (numeric) values</option>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
67 <option value="max">Compute the maximum of the (numeric) values</option>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
68 <option value="mode">Compute the maximum of the (numeric) values</option>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
69 <option value="first">Use the value from the first record in the annotation file</option>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
70 <option value="last">Use the value from the last record in the annotation file</option>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
71 <option value="list">Create a comma-separated list of the observed (text) values</option>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
72 <option value="uniq_list">Create a comma-separated list of non-redundant observed (text) values</option>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
73 </param>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
74
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
75 </when>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
76 <when value="boolean"/>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
77 <when value="count"/>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
78 </conditional>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
79
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
80 </inputs>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
81 <outputs>
2
93bb0cfacefb Uploaded
iuc
parents: 0
diff changeset
82 <data name="outfile" format="tabular" />
0
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
83 </outputs>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
84 <tests>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
85 <test>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
86 </test>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
87 </tests>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
88 <help>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
89 **What it does**
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
90
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
91 It is inevitable that researchers will want to enhance the gemini framework with their own, custom annotations. gemini provides a sub-command called annotate for exactly this purpose.
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
92
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
93 @CITATION@
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
94 </help>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
95 <expand macro="citations"/>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
96 </tool>