annotate microsatcompat.xml @ 1:99ec84eb0bab draft default tip

Uploaded
author arkarachai-fungtammasan
date Wed, 01 Apr 2015 17:00:21 -0400
parents 70f8259b0b30
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="microsatcompat" name="Check microsatellites motif compatibility" version="1.0.0">
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
2 <description> </description>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
3 <command interpreter="python">microsatcompat.py $input $column1 $column2 > $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="input" type="data" label="Select input" />
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
7 <param name="column1" type="integer" value="4" label="First column number" />
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
8 <param name="column2" type="integer" value="10" label="Second column number" />
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
9 </inputs>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
10 <outputs>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
11 <data format="tabular" name="output" />
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
12
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
13 </outputs>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
14 <tests>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
15 <!-- Test data with valid values -->
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
16 <test>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
17 <param name="input" value="microsatcompat_in.txt"/>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
18 <param name="column1" value="4"/>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
19 <param name="column2" value="10"/>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
20 <output name="output" file="microsatcompat_out.txt"/>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
21 </test>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
22
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
23 </tests>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
24 <help>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
25
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
26
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
27 .. class:: infomark
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
28
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
29 **What it does**
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
30
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
31 This tool is used to select only the input lines which have compatible microsatellite motifs between two columns. Compatible here is defined as the microsatellites motif that are complementary or have the same sequence when change starting point of motif. For example, **A** is the same as **T**. Also, **AGG** is the same as **GAG**.
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
32
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
33 For TRFM pipeline (profiling microsatellites in short read data), this tool can be used to make sure that the microsatellites in the reads have the same motif as the microsatellites in the reference at the corresponding mapped location.
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
34
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
35 **Citation**
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
36
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
37 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
38
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
39 **Input**
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
40
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
41 The input files can be any tab delimited file.
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
42
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
43 If this tool is used in TRFM microsatellite profiling, it should contains:
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
44
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
45 - Column 1 = microsatellite location in reference chromosome
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
46 - Column 2 = microsatellite location in reference start
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
47 - Column 3 = microsatellite location in reference stop
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
48 - Column 4 = microsatellite location in reference motif
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
49 - Column 5 = microsatellite location in reference length
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
50 - Column 6 = microsatellite location in reference motif size
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
51 - Column 7 = length of microsatellites (bp)
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
52 - Column 8 = length of left flanking regions (bp)
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
53 - Column 9 = length of right flanking regions (bp)
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
54 - Column 10 = repeat motif (bp)
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
55 - Column 11 = hamming distance
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
56 - Column 12 = read name
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
57 - Column 13 = read sequence with soft masking of microsatellites
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
58 - Column 14 = read quality (the same Phred score scale as input)
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
59 - Column 15 = read name (The same as column 12)
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
60 - Column 16 = chromosome
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
61 - Column 17 = left flanking region start
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
62 - Column 18 = left flanking region stop
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
63 - Column 19 = microsatellite start as infer from pair-end
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
64 - Column 20 = microsatellite stop as infer from pair-end
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
65 - Column 21 = right flanking region start
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
66 - Column 22 = right flanking region stop
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
67 - Column 23 = microsatellite length in reference
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
68 - Column 24 = microsatellite sequence in reference
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
69
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
70 **Output**
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
71
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
72 The same as input format.
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
73
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
74
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
75 </help>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
76 </tool>