annotate PEsortedSAM2readprofile.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="PEsortedSAM2readprofile" name="Combine mapped flaked bases" version="1.0.0">
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
2 <description> from SAM file sorted by readname </description>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
3 <command interpreter="python2.7">PEsortedSAM2readprofile.py $flankedbasesSAM $twobitref $maxTRlength $maxoriginalreadlength $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="flankedbasesSAM" type="data" format="sam" label="Select sorted SAM file (by readname) of flaked bases" />
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
7 <param name="twobitref" type="data" label="Select twobit file reference genome" />
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
8 <param name="maxTRlength" type="integer" value="100" label="Maximum expected microsatellite length (bp)" />
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
9 <param name="maxoriginalreadlength" type="integer" value="101" label="Maxinum original read length" />
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="flankedbasesSAM" value="samplesortedPESAM_C.sam"/>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
19 <param name="twobitref" value="shifted.2bit"/>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
20 <param name="maxTRlength" value="100"/>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
21 <param name="maxoriginalreadlength" value="250"/>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
22 <output name="output" file="samplePESAM_2_profile_C.txt"/>
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 take SAM file sorted by read name, remove unpaired reads, report microsatellites sequences in the reference genome that correspond to the space between paired end reads. Coordinate of start and stop for left and right flanking regions of microsatellites and microsatellite itself as inferred from paired end reads will also be reported.
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
34 - These microsatellites in reference can be used to filter out reads that do not contain microsatellites that concur with microsatellites in reference where the reads mapped to.
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
35
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
36 **Citation**
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
37
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
38 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
39
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
40 **Input**
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
41
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
42 - Sorted SAM files by read name
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
43
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
44 **Output**
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
45
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
46 The output will combined two lines of input which are paired. The output format is as follow.
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
47
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
48 - Column 1 = read name
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
49 - Column 2 = chromosome
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
50 - Column 3 = left flanking region start
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
51 - Column 4 = left flanking region stop
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
52 - Column 5 = microsatellite start
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
53 - Column 6 = microsatellite stop
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
54 - Column 7 = right flanking region start
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
55 - Column 8 = right flanking region stop
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
56 - Column 9 = microsatellite length in reference
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
57 - Column 10= microsatellite sequence in reference
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
58
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
59
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
60
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
61 </help>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
62 </tool>