annotate profilegenerator.xml @ 0:70f8259b0b30 draft

Uploaded
author arkarachai-fungtammasan
date Wed, 01 Apr 2015 16:48:58 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
1 <tool id="Profilegenerator" name="Generate all possible combination of read profile" version="2.0.0">
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
2 <description> of the consecutive allele from given error profile </description>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
3 <command interpreter="python2.7">profilegenerator.py $error_profile $MOTIF $Maxdepth $minprob > $output </command>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
4
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
5 <inputs>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
6 <param name="error_profile" type="data" label="Select error profile" />
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
7 <param name="MOTIF" type="text" value="A" label="Type in a motif of interest (e.g. AGC)" />
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
8 <param name="Maxdepth" type="integer" value="30" label="Maximum read depth of interest" />
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
9 <param name="minprob" type="float" value="0.00000001" label="Minimum error rate to be considered" />
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
10
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
11 </inputs>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
12 <outputs>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
13 <data name="output" format="tabular" />
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
14 </outputs>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
15 <tests>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
16 <!-- Test data with valid values -->
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
17 <test>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
18 <param name="error_profile" value="sampleprofilegenerator_in"/>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
19 <param name="MOTIF" value="A"/>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
20 <param name="Maxdepth" value="3"/>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
21 <param name="minprob" file="0.00000001"/>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
22 <output name="output" file="sampleprofilegenerator_out"/>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
23 </test>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
24
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
25 </tests>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
26 <help>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
27
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
28
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
29 .. class:: infomark
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
30
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
31 **What it does**
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
32
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
33 This tool will generate all possible combination of observed read profile of the consecutive alleles from given error profile. The range of observed read length can be filtered to contain only those that are frequently occur using "Minimum error rate to be considered" parameter.
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
34
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
35 This problem will collect the lists of valid (pass "Minimum error rate to be considered" threshold) observed length profiles from combination of consecutive allele lengths. The lists that are equivalent or the subset of the other lists will be removed. For each depth and each list, length profile were generated from combination with replacement which compatible with python 2.7. There could be redundant error profiles generated from different lists if more than one combination of allele is generated due to overlap range of observed microsatellite lengths. The user need to remove them which can be done easily using **sort | uniq** command in unix.
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
36
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
37
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
38 **Citation**
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
39
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
40 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**
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
41
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
42 **Input**
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
43
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
44 - The error profile needs to contain these three columns.
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
45 - Column 1 = Correct microsatellite length
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
46 - Column 2 = Observed microsatellite length
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
47 - Column 3 = Number of observation
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
48
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
49 **Output**
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
50
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
51 - Column 1 = Place holder for location of microsatellite locus. (just "chr")
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
52 - Column 2 = length profile (length of microsatellite in each read that mapped to this location in comma separated format).
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
53 - Column 3 = motif of microsatellite in this locus.
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
54
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
55 **Example**
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
56
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
57 - Suppose that we provide the following read profile ::
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
58
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
59 9 9 100000
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
60 10 10 91456
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
61 10 9 1259
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
62 11 11 39657
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
63 11 10 1211
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
64 11 12 514
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
65
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
66
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
67 - Using default minimum probability to be consider and motif = A, all observed read lengths are valid. The program will generated lists of observed length profiles from consecutive allele length. ::
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
68
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
69 9:10 = [9,10]
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
70 10:11 = [9,10,11,12]
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
71
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
72 - Lists that are subsets of other lists will be removed. Thus, [9,10] will not be considered.
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
73
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
74 - Then the program will generate all combination with replacement for each depth from each list. Using **maximum read depth =3**, we will ge the following output. ::
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
75
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
76
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
77 chr 9,9 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
78 chr 9,10 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
79 chr 9,11 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
80 chr 9,12 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
81 chr 10,10 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
82 chr 10,11 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
83 chr 10,12 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
84 chr 11,11 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
85 chr 11,12 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
86 chr 12,12 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
87 chr 9,9,9 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
88 chr 9,9,10 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
89 chr 9,9,11 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
90 chr 9,9,12 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
91 chr 9,10,10 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
92 chr 9,10,11 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
93 chr 9,10,12 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
94 chr 9,11,11 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
95 chr 9,11,12 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
96 chr 9,12,12 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
97 chr 10,10,10 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
98 chr 10,10,11 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
99 chr 10,10,12 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
100 chr 10,11,11 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
101 chr 10,11,12 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
102 chr 10,12,12 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
103 chr 11,11,11 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
104 chr 11,11,12 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
105 chr 11,12,12 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
106 chr 12,12,12 A
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
107
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
108
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
109 </help>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
110 </tool>