annotate gemini_comp_hets.xml @ 0:720cbfb4190d draft

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