annotate gemini_query.xml @ 4:ba3abde6775b draft default tip

Uploaded
author iuc
date Thu, 15 Jan 2015 15:33:48 -0500
parents 93bb0cfacefb
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>Querying the GEMINI database</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@">query</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 gemini @BINARY@
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
12
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
13 --in "${in}"
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
14
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
15 #if $gt_filter.strip():
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
16 --gt-filter "${gt_filter}"
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
17 #end if
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
18
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
19 #if $sample_filter.strip():
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
20 --sample-filter "${sample_filter}"
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
21 #end if
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
22
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
23 $show_samples
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
24 $show_families
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
25 $family_wise
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
26 $header
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
27 $dgidb
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
28 #if $region.strip():
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
29 --region "${region}"
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
30 #end if
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
31 #if int($min_kindreds) > 0:
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
32 --min-kindreds $min_kindreds
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
33 #end if
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
34 ##--format FORMAT Format of output (JSON, TPED or default) # we will take default for the time being
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
35 ## --sample-delim STRING The delimiter to be used with the --show-samples option.
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
36
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
37 #if $q.strip():
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
38 -q "${q}"
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
39 #end if
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
40
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
41 "${ infile }"
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
42 > "${ outfile }"
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
43 ]]>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
44 </command>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
45 <!--
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
46 ##TODO:
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
47 - -carrier-summary-by-phenotype CARRIER_SUMMARY
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
48 Output columns of counts of carriers and non-carriers
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
49 stratified by the given sample phenotype column-->
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
50 <expand macro="stdio" />
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
51 <inputs>
2
93bb0cfacefb Uploaded
iuc
parents: 0
diff changeset
52 <expand macro="infile" />
0
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
53
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
54 <param name="q" type="text" area="True" size="5x50" label="The query to be issued to the database" help="(-q)">
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
55 <expand macro="sanitize_query" />
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
56 </param>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
57 <param name="gt_filter" type="text" area="True" size="5x50" label="Restrictions to apply to genotype values" help="(--gt-filer)">
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
58 <expand macro="sanitize_query" />
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
59 </param>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
60 <param name="sample_filter" type="text" area="True" size="5x50" label="SQL filter to use to filter the sample table" help="(--sample-filter)">
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
61 <expand macro="sanitize_query" />
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
62 </param>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
63
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
64 <param name="show_samples" type="boolean" truevalue="--show-samples" falsevalue="" checked="False"
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
65 label="Add a column of all sample names with a variant to each variant" help="(--show-samples)"/>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
66
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
67 <param name="show_families" type="boolean" truevalue="--show-families" falsevalue="" checked="False"
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
68 label="Add a column listing all of the families with a variant to each variant" help="(--show-families)"/>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
69
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
70 <param name="family_wise" type="boolean" truevalue="--family-wise" falsevalue="" checked="False"
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
71 label="Perform the sample-filter on a family-wise basis" help="(--family-wise)"/>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
72
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
73 <expand macro="add_header_column" />
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
74
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
75 <!-- TODO: is there any default values set? -->
2
93bb0cfacefb Uploaded
iuc
parents: 0
diff changeset
76 <param name="min_kindreds" size="4" type="integer" value="-1" label="Minimum number of families for a variant passing a family-wise filter to be in" help="-1 means default values (--min-kindreds)" />
0
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
77
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
78 <param name="dgidb" type="boolean" truevalue="--dgidb" falsevalue="" checked="False"
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
79 label="Request drug-gene interaction info from DGIdb" help="(--dgidb)"/>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
80
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
81 <param name="in" type="select" label="A variant must be in either all, none or any samples passing the sample-query filter" help="(--in)">
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
82 <option value="all">Return a variant if all samples matching the query have the variant. (all)</option>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
83 <option value="none">Return a variant if the variant does not appear in any of the matching samples. (none)</option>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
84 <option value="any">Return all of the variant which are in all of the matching samples and not in any of the non-matching samples. (any)</option>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
85 <option value="only">Return a variant if the variant is only in the matching samples and not in any of the non-matching samples. (only)</option>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
86 </param>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
87
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
88 <param name="region" size="30" type="text" value="" label="Restrict query to this region" help="e.g. chr1:10-20 (--region)"/>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
89
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
90
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
91 </inputs>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
92 <outputs>
2
93bb0cfacefb Uploaded
iuc
parents: 0
diff changeset
93 <data name="outfile" format="tabular" />
0
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
94 </outputs>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
95 <tests>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
96 <test>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
97 </test>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
98 </tests>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
99 <help>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
100 **What it does**
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
101
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
102 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.
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
103 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!
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
104
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
105 http://gemini.readthedocs.org/en/latest/content/querying.html
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
106
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
107 @CITATION@
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
108 </help>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
109 <expand macro="citations"/>
720cbfb4190d Imported from capsule None
iuc
parents:
diff changeset
110 </tool>