annotate gemini_roh.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 runs of homozygosity</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@">roh</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 --min-snps $min_snps
14caa57eca63 Uploaded
iuc
parents:
diff changeset
13 --min-total-depth $min_total_depth
14caa57eca63 Uploaded
iuc
parents:
diff changeset
14 --min-gt-depth $min_gt_depth
14caa57eca63 Uploaded
iuc
parents:
diff changeset
15 --min-size $min_size
14caa57eca63 Uploaded
iuc
parents:
diff changeset
16 --max-hets §max_hets
14caa57eca63 Uploaded
iuc
parents:
diff changeset
17 --max-unknowns $max_unknowns
14caa57eca63 Uploaded
iuc
parents:
diff changeset
18 -s $samples
14caa57eca63 Uploaded
iuc
parents:
diff changeset
19 "${ infile }"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
20 -> "${ outfile }"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
21 ]]>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
22 </command>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
23 <expand macro="stdio" />
14caa57eca63 Uploaded
iuc
parents:
diff changeset
24 <inputs>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
25 <param name="infile" type="data" format="sqlite" label="GEMINI database" />
14caa57eca63 Uploaded
iuc
parents:
diff changeset
26
14caa57eca63 Uploaded
iuc
parents:
diff changeset
27 <param name="min_snps" type="integer" value="25" size="5" label="Minimum number of expected homozygous SNPs" help="default: 25 (--min-snps)">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
28 <validator type="in_range" min="0"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
29 </param>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
30 <param name="min_total_depth" type="integer" value="20" size="10" label="The minimum overall sequencing depth requiredfor a SNP to be considered" help="default: 20 (--min-total-depth)">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
31 <validator type="in_range" min="0"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
32 </param>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
33 <param name="min_gt_depth" type="integer" value="0" size="10" label="The minimum required sequencing depth underlying a given sample's genotype for a SNP to be considered"
14caa57eca63 Uploaded
iuc
parents:
diff changeset
34 help="default: 0 (--min-gt-depth)">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
35 <validator type="in_range" min="0"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
36 </param>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
37 <param name="min_size" type="integer" value="100000" size="10" label="Minimum run size in base pairs" help="default: 100000 (--min-size)">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
38 <validator type="in_range" min="1"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
39 </param>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
40 <param name="max_hets" type="integer" value="1" size="5" label="Maximum number of allowed hets in the run" help="default: 1 (--max-hets)">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
41 <validator type="in_range" min="1"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
42 </param>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
43 <param name="max_unknowns" type="integer" value="3" size="5" label="Maximum number of allowed unknowns in the run" help="default: 3 (-max-unknowns)">
14caa57eca63 Uploaded
iuc
parents:
diff changeset
44 <validator type="in_range" min="0"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
45 </param>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
46
14caa57eca63 Uploaded
iuc
parents:
diff changeset
47 <param name="samples" size="30" type="text" value="" label="Comma separated list of samples to screen for ROHs" help="e.g S120,S450 (-s)"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
48
14caa57eca63 Uploaded
iuc
parents:
diff changeset
49 </inputs>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
50
14caa57eca63 Uploaded
iuc
parents:
diff changeset
51 <outputs>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
52 <data name="outfile" format="tabular" label="${tool.name} on ${on_string}" />
14caa57eca63 Uploaded
iuc
parents:
diff changeset
53 </outputs>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
54 <tests>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
55 <test>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
56 </test>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
57 </tests>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
58 <help>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
59
14caa57eca63 Uploaded
iuc
parents:
diff changeset
60 **What it does**
14caa57eca63 Uploaded
iuc
parents:
diff changeset
61
14caa57eca63 Uploaded
iuc
parents:
diff changeset
62 ===========================================================================
14caa57eca63 Uploaded
iuc
parents:
diff changeset
63 ``ROH``: Identifying runs of homozygosity
14caa57eca63 Uploaded
iuc
parents:
diff changeset
64 ===========================================================================
14caa57eca63 Uploaded
iuc
parents:
diff changeset
65 Runs of homozygosity are long stretches of homozygous genotypes that reflect
14caa57eca63 Uploaded
iuc
parents:
diff changeset
66 segments shared identically by descent and are a result of consanguinity or
14caa57eca63 Uploaded
iuc
parents:
diff changeset
67 natural selection. Consanguinity elevates the occurrence of rare recessive
14caa57eca63 Uploaded
iuc
parents:
diff changeset
68 diseases (e.g. cystic fibrosis) that represent homozygotes for strongly deleterious
14caa57eca63 Uploaded
iuc
parents:
diff changeset
69 mutations. Hence, the identification of these runs holds medical value.
14caa57eca63 Uploaded
iuc
parents:
diff changeset
70
14caa57eca63 Uploaded
iuc
parents:
diff changeset
71 The 'roh' tool in GEMINI returns runs of homozygosity identified in whole genome data.
14caa57eca63 Uploaded
iuc
parents:
diff changeset
72 The tool basically looks at every homozygous position on the chromosome as a possible
14caa57eca63 Uploaded
iuc
parents:
diff changeset
73 start site for the run and looks for those that could give rise to a potentially long
14caa57eca63 Uploaded
iuc
parents:
diff changeset
74 stretch of homozygous genotypes.
14caa57eca63 Uploaded
iuc
parents:
diff changeset
75
14caa57eca63 Uploaded
iuc
parents:
diff changeset
76 For e.g. for the given example allowing ``1 HET`` genotype (h) and ``2 UKW`` genotypes (u)
14caa57eca63 Uploaded
iuc
parents:
diff changeset
77 the possible roh runs (H) would be:
14caa57eca63 Uploaded
iuc
parents:
diff changeset
78
14caa57eca63 Uploaded
iuc
parents:
diff changeset
79
14caa57eca63 Uploaded
iuc
parents:
diff changeset
80 ::
14caa57eca63 Uploaded
iuc
parents:
diff changeset
81
14caa57eca63 Uploaded
iuc
parents:
diff changeset
82 genotype_run = H H H H h H H H H u H H H H H u H H H H H H H h H H H H H h H H H H H
14caa57eca63 Uploaded
iuc
parents:
diff changeset
83 roh_run1 = H H H H h H H H H u H H H H H u H H H H H H H
14caa57eca63 Uploaded
iuc
parents:
diff changeset
84 roh_run2 = H H H H u H H H H H u H H H H H H H h H H H H H
14caa57eca63 Uploaded
iuc
parents:
diff changeset
85 roh_run3 = H H H H H u H H H H H H H h H H H H H
14caa57eca63 Uploaded
iuc
parents:
diff changeset
86 roh_run4 = H H H H H H H h H H H H H
14caa57eca63 Uploaded
iuc
parents:
diff changeset
87
14caa57eca63 Uploaded
iuc
parents:
diff changeset
88 roh returned for --min-snps = 20 would be:
14caa57eca63 Uploaded
iuc
parents:
diff changeset
89
14caa57eca63 Uploaded
iuc
parents:
diff changeset
90 ::
14caa57eca63 Uploaded
iuc
parents:
diff changeset
91
14caa57eca63 Uploaded
iuc
parents:
diff changeset
92 roh_run1 = H H H H h H H H H u H H H H H u H H H H H H H
14caa57eca63 Uploaded
iuc
parents:
diff changeset
93 roh_run2 = H H H H u H H H H H u H H H H H H H h H H H H H
14caa57eca63 Uploaded
iuc
parents:
diff changeset
94
14caa57eca63 Uploaded
iuc
parents:
diff changeset
95
14caa57eca63 Uploaded
iuc
parents:
diff changeset
96 As you can see, the immediate homozygous position right of a break (h or u) would be the possible
14caa57eca63 Uploaded
iuc
parents:
diff changeset
97 start of a new roh run and genotypes to the left of a break are pruned since they cannot
14caa57eca63 Uploaded
iuc
parents:
diff changeset
98 be part of a longer run than we have seen before.
14caa57eca63 Uploaded
iuc
parents:
diff changeset
99
14caa57eca63 Uploaded
iuc
parents:
diff changeset
100
14caa57eca63 Uploaded
iuc
parents:
diff changeset
101 @CITATION@
14caa57eca63 Uploaded
iuc
parents:
diff changeset
102 </help>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
103 <expand macro="citations"/>
14caa57eca63 Uploaded
iuc
parents:
diff changeset
104 </tool>