annotate gemini_comp_hets.xml @ 0:d666cc4a37e7 draft

planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
author iuc
date Thu, 18 Feb 2016 08:52:33 -0500
parents
children ed0b0677dcfe
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
1 <tool id="gemini_@BINARY@" name="GEMINI @BINARY@" version="@VERSION@.0">
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
2 <description>Identifying potential compound heterozygotes</description>
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
3 <macros>
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
4 <import>gemini_macros.xml</import>
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
5 <token name="@BINARY@">comp_hets</token>
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
6 </macros>
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
7 <expand macro="requirements" />
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
8 <expand macro="stdio" />
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
9 <expand macro="version_command" />
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
10 <command>
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
11 <![CDATA[
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
12 gemini @BINARY@
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
13
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
14 #if $report.report_selector != 'all':
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
15 --columns "${report.columns}"
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
16 #end if
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
17
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
18 @CMDLN_SQL_FILTER_FILTER_OPTION@
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
19
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
20 #if int($min_kindreds) > 0:
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
21 --min-kindreds $min_kindreds
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
22 #end if
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
23
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
24 #if str($families).strip():
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
25 --families "$families"
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
26 #end if
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
27
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
28 -d $d
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
29 $allow_unaffected
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
30
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
31 #if int($min_genotypequality) > 0:
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
32 --min-gq $min_genotypequality
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
33 #end if
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
34
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
35 #if int($gt_pl_max) != -1:
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
36 --gt_pl_max $gt_pl_max
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
37 #end if
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
38
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
39 $pattern_only
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
40 --max-priority $max_priority
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
41
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
42
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
43 "${ infile }"
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
44 > "${ outfile }"
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
45 ]]>
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
46 </command>
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
47 <inputs>
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
48 <expand macro="infile" />
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
49 <expand macro="column_filter" />
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
50 <expand macro="filter" />
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
51 <expand macro="min_kindreds" />
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
52 <expand macro="family" />
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
53 <expand macro="unaffected" />
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
54 <expand macro="min_sequence_depth" />
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
55 <param name="min_genotypequality" type="integer" value="0" min="0" label="The minimum genotype quality required for each sample in a family." help="default: 0 (--min-gq)" />
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
56 <param name="gt_pl_max" type="integer" value="-1" min="-1" label="The maximum phred-scaled genotype (PL) allowed for each sample in a family." help="default: -1 not set (--gt-pl-max)" />
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
57 <param name="pattern_only" type="boolean" truevalue="--pattern-only" falsevalue="" checked="False"
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
58 label="Find compound hets by inheritance pattern, without regard to affection" help="(--pattern-only)"/>
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
59 <param name="max_priority" type="integer" value="1" min="1" label="Default is to show only confident compound hets. Set to 2 or higher to include pairs that are less likely true comp-hets." help="default: 1 (--max-priority)" />
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
60 </inputs>
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
61 <outputs>
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
62 <data name="outfile" format="tabular" />
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
63 </outputs>
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
64 <tests>
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
65 <test>
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
66 <param name="infile" value="gemini_comphets_input.db" ftype="gemini.sqlite" />
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
67 <param name="report_selector" value="column_filter" />
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
68 <param name="columns" value="chrom,start,end,ref,alt,gene,impact" />
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
69 <param name="allow_unaffected" value="True" />
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
70 <param name="max_priority" value="3" />
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
71 <output name="outfile" file="gemini_comphets_result.tabular" />
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
72 </test>
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
73 </tests>
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
74 <help>
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
75 **What it does**
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
76
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
77 Many recessive disorders are caused by compound heterozygotes. Unlike canonical recessive sites where the same recessive allele is
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
78 inherited from both parents at the _same_ site in the gene, compound heterozygotes occur when the individual’s phenotype is caused
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
79 by two heterozygous recessive alleles at _different_ sites in a particular gene.
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
80
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
81 So basically, we are looking for two (typically loss-of-function (LoF)) heterozygous variants impacting the same gene at different loci.
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
82 The complicating factor is that this is _recessive_ and as such, we must also require that the consequential alleles at each heterozygous
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
83 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.
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
84 Once this has been done, the comp_hets tool will provide a report of candidate compound heterozygotes for each sample/gene.
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
85
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
86
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
87 </help>
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
88 <expand macro="citations"/>
d666cc4a37e7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/gemini commit 4bbfca6f0e9cae9a8f263aad4eab7304c96358c4
iuc
parents:
diff changeset
89 </tool>