annotate PEsortedSAM2readprofile.xml @ 13:35aedbe548b9 draft

Uploaded
author arkarachai-fungtammasan
date Sun, 24 Jul 2016 17:56:49 -0400
parents d5ed5c2e25c3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13
35aedbe548b9 Uploaded
arkarachai-fungtammasan
parents: 2
diff changeset
1 <tool id="PEsortedSAM2readprofile" name="Combine mapped faux paired-end reads" version="1.1.0">
2
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
2 <description> and get the reference STR allele from the reference genome </description>
0
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
3 <command interpreter="python2.7">PEsortedSAM2readprofile.py $flankedbasesSAM $twobitref $maxTRlength $maxoriginalreadlength $output </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="flankedbasesSAM" type="data" format="sam" label="Select sorted SAM file (by readname) of flaked bases" />
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
7 <param name="twobitref" type="data" label="Select twobit file reference genome" />
13
35aedbe548b9 Uploaded
arkarachai-fungtammasan
parents: 2
diff changeset
8 <param name="maxTRlength" type="integer" value="100" label="Maximum microsatellite length in reference (bp)" />
0
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
9 <param name="maxoriginalreadlength" type="integer" value="101" label="Maxinum original read length" />
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
10
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
11 </inputs>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
12 <outputs>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
13 <data name="output" format="tabular" />
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
14 </outputs>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
15 <tests>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
16 <!-- Test data with valid values -->
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
17 <test>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
18 <param name="flankedbasesSAM" value="samplesortedPESAM_C.sam"/>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
19 <param name="twobitref" value="shifted.2bit"/>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
20 <param name="maxTRlength" value="100"/>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
21 <param name="maxoriginalreadlength" value="250"/>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
22 <output name="output" file="samplePESAM_2_profile_C.txt"/>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
23 </test>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
24
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
25 </tests>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
26 <help>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
27
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
28
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
29 .. class:: infomark
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
30
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
31 **What it does**
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
32
2
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
33 - This tool will take SAM file (sorted by read name), remove unpaired reads, and combine paired faux read-pairs into a single row. It also reports Short Tandem Repeats (STRs) sequences in the reference genome that correspond to the space between the faux paired end reads and the coordinate of start and stop for left and right flanking regions of STRs.
0
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
34
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
35 **Citation**
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
36
07588b899c13 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**
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
38
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
39 **Input**
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
40
2
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
41 - Sorted SAM files by read name.
0
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
42
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
43 **Output**
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
44
2
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
45 The output will combine the two faux paired-end read lines of input ito the following single line format:
0
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
46
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
47 - Column 1 = read name
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
48 - Column 2 = chromosome
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
49 - Column 3 = left flanking region start
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
50 - Column 4 = left flanking region stop
2
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
51 - Column 5 = STR start
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
52 - Column 6 = STR stop
0
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
53 - Column 7 = right flanking region start
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
54 - Column 8 = right flanking region stop
2
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
55 - Column 9 = STR length in reference
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
56 - Column 10= STR sequence in reference
0
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
57
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
58
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
59
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
60 </help>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
61 </tool>