annotate gemini_macros.xml @ 2:e6512af21622 draft

Uploaded
author iuc
date Sun, 24 Aug 2014 17:49:00 -0400
parents 5fec0c2b77c7
children ca4449689d61
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
14caa57eca63 Uploaded
iuc
parents:
diff changeset
26 <xml name="add_header_column">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
27 <param name="header" type="boolean" truevalue="--header" falsevalue="" checked="False"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
28 label="Add a header of column names to the output" help="(--header)"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
29 </xml>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
30
14caa57eca63 Uploaded
iuc
parents:
diff changeset
31 <xml name="radius">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
32 <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
33 <validator type="in_range" min="0"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
34 </param>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
35 </xml>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
36 <xml name="variant_mode">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
37 <param name="variant_mode" type="boolean" truevalue="--var" falsevalue="" checked="False"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
38 label="Returns variant info (e.g. impact, biotype) for interacting genes" help="(--var)"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
39 </xml>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
40
14caa57eca63 Uploaded
iuc
parents:
diff changeset
41 <xml name="column_filter">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
42 <conditional name="report">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
43 <param name="report_selector" type="select" label="Columns to include in the report"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
44 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
45 <option value="all" selected="True">all</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
46 <option value="column_filter">User given columns</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
47 </param>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
48 <when value="all"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
49 <when value="column_filter">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
50 <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
51 <option value="gene">gene</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
52 <option value="chrom">chrom</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
53 <option value="start">start</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
54 <option value="end">end</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
55 <option value="ref">ref</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
56 <option value="alt">alt</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
57 <option value="impact">impact</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
58 <option value="impact_severity">impact_severity</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
59 </param>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
60 </when>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
61 </conditional>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
62 </xml>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
63
14caa57eca63 Uploaded
iuc
parents:
diff changeset
64 <xml name="filter">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
65 <conditional name="filter">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
66 <param name="filter_selector" type="select" label="Apply additional constraints"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
67 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
68 <option value="no">No additional constraints</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
69 <option value="yes">Apply additional constraints</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
70 </param>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
71 <when value="no"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
72 <when value="yes">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
73 <param name="filter" type="text" 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)" />
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="min_sequence_depth">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
79 <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
80 help="default: 0 (-d)">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
81 <validator type="in_range" min="0"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
82 </param>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
83 </xml>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
84
14caa57eca63 Uploaded
iuc
parents:
diff changeset
85 <token name="@VERSION@">0.9.1</token>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
86
14caa57eca63 Uploaded
iuc
parents:
diff changeset
87 <token name="@CITATION@">------
14caa57eca63 Uploaded
iuc
parents:
diff changeset
88
14caa57eca63 Uploaded
iuc
parents:
diff changeset
89 **Citation**
14caa57eca63 Uploaded
iuc
parents:
diff changeset
90
14caa57eca63 Uploaded
iuc
parents:
diff changeset
91 If you use GEMINI in your research, please cite the following manuscript:
14caa57eca63 Uploaded
iuc
parents:
diff changeset
92
14caa57eca63 Uploaded
iuc
parents:
diff changeset
93 </token>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
94 <xml name="citations">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
95 <citations>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
96 <citation type="doi">10.1371/journal.pcbi.1003153</citation>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
97 <yield />
14caa57eca63 Uploaded
iuc
parents:
diff changeset
98 </citations>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
99 </xml>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
100 </macros>