annotate gemini_query.xml @ 0:14caa57eca63 draft

Uploaded
author iuc
date Mon, 11 Aug 2014 07:44:30 -0400
parents
children e6512af21622
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
14caa57eca63 Uploaded
iuc
parents:
diff changeset
1 <tool id="gemini_@BINARY@" name="GEMINI @BINARY@" version="@VERSION@.0">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
2 <description></description>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
3 <expand macro="requirements" />
14caa57eca63 Uploaded
iuc
parents:
diff changeset
4 <expand macro="version_command" />
14caa57eca63 Uploaded
iuc
parents:
diff changeset
5 <macros>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
6 <import>gemini_macros.xml</import>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
7 <token name="@BINARY@">query</token>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
8 </macros>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
9 <command>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
10 <![CDATA[
14caa57eca63 Uploaded
iuc
parents:
diff changeset
11 gemini @BINARY@
14caa57eca63 Uploaded
iuc
parents:
diff changeset
12
14caa57eca63 Uploaded
iuc
parents:
diff changeset
13 #if $q.strip():
14caa57eca63 Uploaded
iuc
parents:
diff changeset
14 -q "${q}"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
15 #end if
14caa57eca63 Uploaded
iuc
parents:
diff changeset
16
14caa57eca63 Uploaded
iuc
parents:
diff changeset
17 #if $gt_filter.strip():
14caa57eca63 Uploaded
iuc
parents:
diff changeset
18 --gt-filter "${gt_filter}"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
19 #end if
14caa57eca63 Uploaded
iuc
parents:
diff changeset
20
14caa57eca63 Uploaded
iuc
parents:
diff changeset
21 #if $sample_filter.strip():
14caa57eca63 Uploaded
iuc
parents:
diff changeset
22 --sample-filter "${sample_filter}"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
23 #end if
14caa57eca63 Uploaded
iuc
parents:
diff changeset
24
14caa57eca63 Uploaded
iuc
parents:
diff changeset
25 $show_samples
14caa57eca63 Uploaded
iuc
parents:
diff changeset
26 $show_families
14caa57eca63 Uploaded
iuc
parents:
diff changeset
27 $family_wise
14caa57eca63 Uploaded
iuc
parents:
diff changeset
28 $header
14caa57eca63 Uploaded
iuc
parents:
diff changeset
29 $dgidb
14caa57eca63 Uploaded
iuc
parents:
diff changeset
30 --in $in
14caa57eca63 Uploaded
iuc
parents:
diff changeset
31 #if $region.strip():
14caa57eca63 Uploaded
iuc
parents:
diff changeset
32 --region "${region}"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
33 #end if
14caa57eca63 Uploaded
iuc
parents:
diff changeset
34 #if int($min_kindreds) > 0:
14caa57eca63 Uploaded
iuc
parents:
diff changeset
35 --min-kindreds $min_kindreds
14caa57eca63 Uploaded
iuc
parents:
diff changeset
36 #end if
14caa57eca63 Uploaded
iuc
parents:
diff changeset
37 ##--format FORMAT Format of output (JSON, TPED or default) # we will take default for the time being
14caa57eca63 Uploaded
iuc
parents:
diff changeset
38 ## --sample-delim STRING The delimiter to be used with the --show-samples option.
14caa57eca63 Uploaded
iuc
parents:
diff changeset
39
14caa57eca63 Uploaded
iuc
parents:
diff changeset
40
14caa57eca63 Uploaded
iuc
parents:
diff changeset
41
14caa57eca63 Uploaded
iuc
parents:
diff changeset
42
14caa57eca63 Uploaded
iuc
parents:
diff changeset
43 "${ infile }"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
44 > "${ outfile }"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
45 ]]>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
46 </command>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
47 <!--
14caa57eca63 Uploaded
iuc
parents:
diff changeset
48 ##TODO:
14caa57eca63 Uploaded
iuc
parents:
diff changeset
49 - -carrier-summary-by-phenotype CARRIER_SUMMARY
14caa57eca63 Uploaded
iuc
parents:
diff changeset
50 Output columns of counts of carriers and non-carriers
14caa57eca63 Uploaded
iuc
parents:
diff changeset
51 stratified by the given sample phenotype column-->
14caa57eca63 Uploaded
iuc
parents:
diff changeset
52 <expand macro="stdio" />
14caa57eca63 Uploaded
iuc
parents:
diff changeset
53 <inputs>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
54 <param name="infile" type="data" format="sqlite" label="GEMINI database" />
14caa57eca63 Uploaded
iuc
parents:
diff changeset
55
14caa57eca63 Uploaded
iuc
parents:
diff changeset
56 <param name="q" type="text" area="True" size="5x50" label="The query to be issued to the database"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
57 <param name="gt_filter" type="text" area="True" size="5x50" label="Restrictions to apply to genotype values"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
58 <param name="sample_filter" type="text" area="True" size="5x50" label="SQL filter to use to filter the sample table"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
59 <param name="sample_filter" type="text" area="True" size="5x50" label="SQL filter to use to filter the sample table"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
60
14caa57eca63 Uploaded
iuc
parents:
diff changeset
61 <param name="show_samples" type="boolean" truevalue="--show-samples" falsevalue="" checked="False"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
62 label="Add a column of all sample names with a variant to each variant" help="(--show-samples)"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
63
14caa57eca63 Uploaded
iuc
parents:
diff changeset
64 <param name="show_families" type="boolean" truevalue="--show-families" falsevalue="" checked="False"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
65 label="Add a column listing all of the families with a variant to each variant" help="(--show-families)"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
66
14caa57eca63 Uploaded
iuc
parents:
diff changeset
67 <param name="family_wise" type="boolean" truevalue="--family-wise" falsevalue="" checked="False"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
68 label="Perform the sample-filter on a family-wise basis" help="(--family-wise)"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
69
14caa57eca63 Uploaded
iuc
parents:
diff changeset
70 <expand macro="add_header_column" />
14caa57eca63 Uploaded
iuc
parents:
diff changeset
71
14caa57eca63 Uploaded
iuc
parents:
diff changeset
72 <!-- TODO: is there any default values set? -->
14caa57eca63 Uploaded
iuc
parents:
diff changeset
73 <param name="min_kindreds" size="4" type="integer" value="-1" lebel="Minimum number of families for a variant passing a family-wise filter to be in" help="-1 means default values (--min-kindreds)" />
14caa57eca63 Uploaded
iuc
parents:
diff changeset
74
14caa57eca63 Uploaded
iuc
parents:
diff changeset
75 <param name="dgidb" type="boolean" truevalue="--dgidb" falsevalue="" checked="False"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
76 label="Request drug-gene interaction info from DGIdb" help="(--dgidb)"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
77
14caa57eca63 Uploaded
iuc
parents:
diff changeset
78 <param name="in" type="select" label="A variant must be in either all, none or any samples passing the sample-query filter" help="(--in)">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
79 <option value="all">all</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
80 <option value="none">none</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
81 <option value="any">any</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
82 <option value="only">only</option>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
83 </param>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
84
14caa57eca63 Uploaded
iuc
parents:
diff changeset
85 <param name="region" size="30" type="text" value="" label="Restrict query to this region" help="e.g. chr1:10-20 (--region)"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
86
14caa57eca63 Uploaded
iuc
parents:
diff changeset
87
14caa57eca63 Uploaded
iuc
parents:
diff changeset
88 </inputs>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
89 <outputs>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
90 <data name="outfile" format="tabular" label="${tool.name} on ${on_string}" />
14caa57eca63 Uploaded
iuc
parents:
diff changeset
91 </outputs>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
92 <tests>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
93 <test>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
94 </test>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
95 </tests>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
96 <help>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
97 **What it does**
14caa57eca63 Uploaded
iuc
parents:
diff changeset
98
14caa57eca63 Uploaded
iuc
parents:
diff changeset
99 The real power in the GEMINI framework lies in the fact that all of your genetic variants have been stored in a convenient database in the context of a wealth of genome annotations that facilitate variant interpretation.
14caa57eca63 Uploaded
iuc
parents:
diff changeset
100 The expressive power of SQL allows one to pose intricate questions of one’s variation data. This tool offers you an easy way to query your variants!
14caa57eca63 Uploaded
iuc
parents:
diff changeset
101
14caa57eca63 Uploaded
iuc
parents:
diff changeset
102 http://gemini.readthedocs.org/en/latest/content/querying.html
14caa57eca63 Uploaded
iuc
parents:
diff changeset
103
14caa57eca63 Uploaded
iuc
parents:
diff changeset
104 @CITATION@
14caa57eca63 Uploaded
iuc
parents:
diff changeset
105 </help>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
106 <expand macro="citations"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
107 </tool>