annotate gemini_macros.xml @ 9:fc853d53532c draft

Uploaded
author iuc
date Mon, 25 Aug 2014 16:28:15 -0400
parents 71dc82354595
children 0f1bcedd836f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
14caa57eca63 Uploaded
iuc
parents:
diff changeset
1 <macros>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
2 <xml name="requirements">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
3 <requirements>
2
e6512af21622 Uploaded
iuc
parents: 1
diff changeset
4 <requirement type="package" version="0.10.0">gemini</requirement>
0
14caa57eca63 Uploaded
iuc
parents:
diff changeset
5 <requirement type="package" version="0.1.3">grabix</requirement>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
6 <requirement type="package" version="0.2.6">tabix</requirement>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
7 <requirement type="package" version="0.1.19">samtools</requirement>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
8 <requirement type="package" version="2.19.1">bedtools</requirement>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
9 <yield />
14caa57eca63 Uploaded
iuc
parents:
diff changeset
10 </requirements>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
11 </xml>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
12
14caa57eca63 Uploaded
iuc
parents:
diff changeset
13 <xml name="version_command">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
14 <version_command>gemini --version</version_command>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
15 </xml>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
16
14caa57eca63 Uploaded
iuc
parents:
diff changeset
17 <xml name="stdio">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
18 <stdio>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
19 <exit_code range="1:" />
14caa57eca63 Uploaded
iuc
parents:
diff changeset
20 <exit_code range=":-1" />
14caa57eca63 Uploaded
iuc
parents:
diff changeset
21 <regex match="Error:" />
14caa57eca63 Uploaded
iuc
parents:
diff changeset
22 <regex match="Exception:" />
14caa57eca63 Uploaded
iuc
parents:
diff changeset
23 </stdio>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
24 </xml>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
25
4
ca4449689d61 Uploaded
iuc
parents: 2
diff changeset
26 <xml name="annotation_dir">
ca4449689d61 Uploaded
iuc
parents: 2
diff changeset
27 <param name="annotation_databases" type="select" label="Choose a gemini annotation database">
6
5e0f81024cd4 Uploaded
iuc
parents: 5
diff changeset
28 <options from_data_table="gemini_databases">
9
fc853d53532c Uploaded
iuc
parents: 8
diff changeset
29 <column name="value" index="0"/>
fc853d53532c Uploaded
iuc
parents: 8
diff changeset
30 <column name="dbkey" index="1"/>
fc853d53532c Uploaded
iuc
parents: 8
diff changeset
31 <column name="name" index="2"/>
fc853d53532c Uploaded
iuc
parents: 8
diff changeset
32 <column name="path" index="3"/>
fc853d53532c Uploaded
iuc
parents: 8
diff changeset
33 <filter type="sort_by" column="0" />
fc853d53532c Uploaded
iuc
parents: 8
diff changeset
34 <validator type="unspecified_build" />
fc853d53532c Uploaded
iuc
parents: 8
diff changeset
35 <validator type="no_options" message="No annotation database is available" />
4
ca4449689d61 Uploaded
iuc
parents: 2
diff changeset
36 </options>
ca4449689d61 Uploaded
iuc
parents: 2
diff changeset
37 </param>
ca4449689d61 Uploaded
iuc
parents: 2
diff changeset
38 </xml>
ca4449689d61 Uploaded
iuc
parents: 2
diff changeset
39
0
14caa57eca63 Uploaded
iuc
parents:
diff changeset
40 <xml name="add_header_column">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
41 <param name="header" type="boolean" truevalue="--header" falsevalue="" checked="False"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
42 label="Add a header of column names to the output" help="(--header)"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
43 </xml>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
44
14caa57eca63 Uploaded
iuc
parents:
diff changeset
45 <xml name="radius">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
46 <param name="radius" type="integer" value="3" size="5" label="Set filter for Breadth-first search (BFS) in the Protein-Protein Interaction network" help="(-r)" >
14caa57eca63 Uploaded
iuc
parents:
diff changeset
47 <validator type="in_range" min="0"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
48 </param>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
49 </xml>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
50 <xml name="variant_mode">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
51 <param name="variant_mode" type="boolean" truevalue="--var" falsevalue="" checked="False"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
52 label="Returns variant info (e.g. impact, biotype) for interacting genes" help="(--var)"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
53 </xml>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
54
14caa57eca63 Uploaded
iuc
parents:
diff changeset
55 <xml name="column_filter">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
56 <conditional name="report">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
57 <param name="report_selector" type="select" label="Columns to include in the report"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
58 help="By default, this tool reports all columns in the variants table. One may choose to report only a subset of the columns.">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
59 <option value="all" selected="True">all</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
60 <option value="column_filter">User given columns</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
61 </param>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
62 <when value="all"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
63 <when value="column_filter">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
64 <param name="columns" type="select" display="checkboxes" multiple="True" label="Choose columns to include in the report" help="(--columns)">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
65 <option value="gene">gene</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
66 <option value="chrom">chrom</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
67 <option value="start">start</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
68 <option value="end">end</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
69 <option value="ref">ref</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
70 <option value="alt">alt</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
71 <option value="impact">impact</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
72 <option value="impact_severity">impact_severity</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
73 </param>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
74 </when>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
75 </conditional>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
76 </xml>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
77
14caa57eca63 Uploaded
iuc
parents:
diff changeset
78 <xml name="filter">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
79 <conditional name="filter">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
80 <param name="filter_selector" type="select" label="Apply additional constraints"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
81 help="By default, this tool will report all variants regardless of their putative functional impact. In order to apply additional constraints on the variants returned, you can this optional filter.">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
82 <option value="no">No additional constraints</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
83 <option value="yes">Apply additional constraints</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
84 </param>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
85 <when value="no"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
86 <when value="yes">
8
71dc82354595 Uploaded
iuc
parents: 6
diff changeset
87 <param name="filter" type="text" size="20" label="Contraints in SQL syntax" help="Conditions applied here will become WHERE clauses in the query issued to the GEMINI database. E.g. alt='G' or impact_severity = 'HIGH'. (--filter)">
71dc82354595 Uploaded
iuc
parents: 6
diff changeset
88 <expand macro="sanitize_query" />
71dc82354595 Uploaded
iuc
parents: 6
diff changeset
89 </param>
0
14caa57eca63 Uploaded
iuc
parents:
diff changeset
90 </when>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
91 </conditional>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
92 </xml>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
93
8
71dc82354595 Uploaded
iuc
parents: 6
diff changeset
94 <xml name="sanitize_query">
71dc82354595 Uploaded
iuc
parents: 6
diff changeset
95 <sanitizer invalid_char="">
71dc82354595 Uploaded
iuc
parents: 6
diff changeset
96 <valid initial="string.printable">
71dc82354595 Uploaded
iuc
parents: 6
diff changeset
97 </valid>
71dc82354595 Uploaded
iuc
parents: 6
diff changeset
98 </sanitizer>
71dc82354595 Uploaded
iuc
parents: 6
diff changeset
99 </xml>
71dc82354595 Uploaded
iuc
parents: 6
diff changeset
100
0
14caa57eca63 Uploaded
iuc
parents:
diff changeset
101 <xml name="min_sequence_depth">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
102 <param name="d" type="integer" value="0" size="5" label="The minimum aligned sequence depth (genotype DP) required for each sample"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
103 help="default: 0 (-d)">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
104 <validator type="in_range" min="0"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
105 </param>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
106 </xml>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
107
5
6ab82d8ca805 Uploaded
iuc
parents: 4
diff changeset
108 <token name="@VERSION@">0.10.0</token>
0
14caa57eca63 Uploaded
iuc
parents:
diff changeset
109
14caa57eca63 Uploaded
iuc
parents:
diff changeset
110 <token name="@CITATION@">------
14caa57eca63 Uploaded
iuc
parents:
diff changeset
111
14caa57eca63 Uploaded
iuc
parents:
diff changeset
112 **Citation**
14caa57eca63 Uploaded
iuc
parents:
diff changeset
113
14caa57eca63 Uploaded
iuc
parents:
diff changeset
114 If you use GEMINI in your research, please cite the following manuscript:
14caa57eca63 Uploaded
iuc
parents:
diff changeset
115
14caa57eca63 Uploaded
iuc
parents:
diff changeset
116 </token>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
117 <xml name="citations">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
118 <citations>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
119 <citation type="doi">10.1371/journal.pcbi.1003153</citation>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
120 <yield />
14caa57eca63 Uploaded
iuc
parents:
diff changeset
121 </citations>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
122 </xml>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
123 </macros>