annotate probvalueforhetero.xml @ 10:d423f0de87b7 draft

Uploaded
author arkarachai-fungtammasan
date Fri, 04 Sep 2015 09:57:51 -0400
parents d5ed5c2e25c3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
1 <tool id="heteroprob" name="Evaluate the probability of the allele combination to generate read profile" version="2.0.0">
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
2 <description></description>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
3 <command interpreter="python2.7">heteroprob.py $microsat_raw $microsat_error_profile $expectedminorallele > $microsat_corrected </command>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
4
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
5 <inputs>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
6 <param name="microsat_raw" type="data" label="Select microsatellite length profile and allele combination file" />
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
7 <param name="microsat_error_profile" type="data" label="Select microsatellite error profile that correspond to this dataset" />
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
8 <param name="expectedminorallele" type="float" value="0.5" label="Expected contribution of minor allele when present (0.5 for genotyping)" />
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
9
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
10 </inputs>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
11 <outputs>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
12 <data name="microsat_corrected" format="tabular" />
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
13 </outputs>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
14 <tests>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
15 <!-- Test data with valid values -->
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
16 <test>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
17 <param name="microsat_raw" value="probvalueforhetero_in.txt"/>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
18 <param name="microsat_error_profile" value="PCRinclude.allrate.bymajorallele"/>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
19 <param name="expectedminorallele" value="0.5"/>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
20 <output name="microsat_corrected" file="probvalueforhetero_out.txt"/>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
21 </test>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
22
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
23 </tests>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
24 <help>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
25
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
26
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
27 .. class:: infomark
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
28
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
29 **What it does**
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
30
2
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
31 - This tool will calculate the probability that the allele combination can generated the given the STR length profile. This tool is part of the pipeline to estimate minimum read depth.
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
32 - The calculation of probability is very similar to the tool **Correct genotype for STR errors**. However, this tool will restrict the calculation to only the allele combination indicated in input. Also, when it encounter allele combination that cannot be generated from error profile, the total probability will be zero instead of using base substitution rate.
0
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
33
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
34 **Citation**
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
35
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
36 When you use this tool, please cite **Fungtammasan A, Ananda G, Hile SE, Su MS, Sun C, Harris R, Medvedev P, Eckert K, Makova KD. 2015. Accurate Typing of Short Tandem Repeats from Genome-wide Sequencing Data and its Applications, Genome Research**
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
37
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
38 **Input**
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
39
2
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
40 The input format is the same as output from **Correct genotype for STR errors** tool.
0
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
41
2
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
42 - Column 1 = location of STR locus.
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
43 - Column 2 = length profile (length of STR in each read that mapped to this location in comma separated format).
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
44 - Column 3 = motif of STR in this locus. The input file can contain more than three column.
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
45 - Column 4 = homozygote/heterozygote label.
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
46 - Column 5 = log based 10 of (the probability of homozygote/the probability of heterozygote)
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
47 - Column 6 = Allele for most probable homozygote.
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
48 - Column 7 = Allele 1 for most probable heterozygote.
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
49 - Column 8 = Allele 2 for most probable heterozygote.
0
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
50
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
51 Only column 2,3,7,8 were used in calculation.
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
52
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
53 **Output**
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
54
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
55
2
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
56 The output will contain the original eight columns from the input and the following additional columns.
0
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
57 - Column 9 = Probability of the allele combination to generate given read profile.
2
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
58 - Column 10 = Number of possible rearrangements of the given read profile.
0
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
59 - Column 11 = Probability of the allele combination to generate read profile with any rearrangement (Product of column 9 and column 10)
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
60 - Column 12 = Read depth
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
61
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
62
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
63
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
64
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
65 </help>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
66 </tool>