annotate gemini_comp_hets.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>Identifying potential compound heterozygotes</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@">comp_hets</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 $report.report_selector != 'all':
14caa57eca63 Uploaded
iuc
parents:
diff changeset
14 --columns "${report.columns}"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
15 #end if
14caa57eca63 Uploaded
iuc
parents:
diff changeset
16
14caa57eca63 Uploaded
iuc
parents:
diff changeset
17 #if $filter.filter_selector == 'yes':
14caa57eca63 Uploaded
iuc
parents:
diff changeset
18 --filter "${filter.filter}"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
19 #end if
14caa57eca63 Uploaded
iuc
parents:
diff changeset
20 $only_affected
14caa57eca63 Uploaded
iuc
parents:
diff changeset
21 $ignore_phasing
14caa57eca63 Uploaded
iuc
parents:
diff changeset
22
14caa57eca63 Uploaded
iuc
parents:
diff changeset
23 "${ infile }"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
24 > "${ outfile }"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
25 ]]>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
26 </command>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
27 <expand macro="stdio" />
14caa57eca63 Uploaded
iuc
parents:
diff changeset
28 <inputs>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
29 <param name="infile" type="data" format="sqlite" label="GEMINI database" />
14caa57eca63 Uploaded
iuc
parents:
diff changeset
30 <expand macro="add_header_column" />
14caa57eca63 Uploaded
iuc
parents:
diff changeset
31 <param name="only_affected" type="boolean" truevalue="--only-affected" falsevalue="" checked="False"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
32 label="Report solely those compund heterozygotes impacted a sample labeled as affected" help="(--only-affected)"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
33 <param name="ignore_phasing" type="boolean" truevalue="--ignore-phasing" falsevalue="" checked="False"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
34 label="Ignore phasing when screening for compound hets" help="Candidates are inherently putative. (--ignore-phasing)"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
35 <expand macro="filter" />
14caa57eca63 Uploaded
iuc
parents:
diff changeset
36 </inputs>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
37 <outputs>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
38 <data name="outfile" format="tabular" label="${tool.name} on ${on_string}" />
14caa57eca63 Uploaded
iuc
parents:
diff changeset
39 </outputs>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
40 <tests>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
41 <test>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
42 </test>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
43 </tests>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
44 <help>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
45 **What it does**
14caa57eca63 Uploaded
iuc
parents:
diff changeset
46
14caa57eca63 Uploaded
iuc
parents:
diff changeset
47 Many recessive disorders are caused by compound heterozygotes. Unlike canonical recessive sites where the same recessive allele is
14caa57eca63 Uploaded
iuc
parents:
diff changeset
48 inherited from both parents at the _same_ site in the gene, compound heterozygotes occur when the individual’s phenotype is caused
14caa57eca63 Uploaded
iuc
parents:
diff changeset
49 by two heterozygous recessive alleles at _different_ sites in a particular gene.
14caa57eca63 Uploaded
iuc
parents:
diff changeset
50
14caa57eca63 Uploaded
iuc
parents:
diff changeset
51 So basically, we are looking for two (typically loss-of-function (LoF)) heterozygous variants impacting the same gene at different loci.
14caa57eca63 Uploaded
iuc
parents:
diff changeset
52 The complicating factor is that this is _recessive_ and as such, we must also require that the consequential alleles at each heterozygous
14caa57eca63 Uploaded
iuc
parents:
diff changeset
53 site were inherited on different chromosomes (one from each parent). As such, in order to use this tool, we require that all variants are phased.
14caa57eca63 Uploaded
iuc
parents:
diff changeset
54 Once this has been done, the comp_hets tool will provide a report of candidate compound heterozygotes for each sample/gene.
14caa57eca63 Uploaded
iuc
parents:
diff changeset
55
14caa57eca63 Uploaded
iuc
parents:
diff changeset
56
14caa57eca63 Uploaded
iuc
parents:
diff changeset
57 @CITATION@
14caa57eca63 Uploaded
iuc
parents:
diff changeset
58 </help>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
59 <expand macro="citations"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
60 </tool>