annotate fetchflank.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
2
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
1 <tool id="fetchflank" name="Fetch bases flanking" version="1.0.0">
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
2 <description> the STRs in the reads and output two fastq files in forward-forward orientation</description>
0
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
3 <command interpreter="python">pair_fetch_DNA_ff.py $microsat_in_read $Leftflanking $Rightflanking $qualitycutoff $lengthofbasetocheckquality </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_in_read" type="data" label="Select data of microsatellites in reads" />
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
7 <param name="qualitycutoff" type="integer" value="20" label="Minimum quality score (Phred+33) for microsatellites and flanking regions" />
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
8 <param name="lengthofbasetocheckquality" type="integer" value="20" label="Length of flanking regions that require quality screening" />
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
9 </inputs>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
10 <outputs>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
11 <data format="fastq" name="Leftflanking" />
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
12 <data format="fastq" name="Rightflanking" />
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_in_read" value="samplefq.snoope"/>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
18 <param name="qualitycutoff" value="20"/>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
19 <param name="lengthofbasetocheckquality" value="20"/>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
20 <output name="Leftflanking" file="microsatellite_flanking_L.fastq"/>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
21 <output name="Rightflanking" file="microsatellite_flanking_R.fastq"/>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
22 </test>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
23
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
24 </tests>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
25 <help>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
26
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
27
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
28 .. class:: infomark
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
29
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
30 **What it does**
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
31
2
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
32 This tool will fetch flanking regions around STRs from the reads output by "STR detection" step, screen for quality score at STRs and adjacent flanking regions, and output two fastq files containing flanking regions in forward-forward direction.
0
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
33
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
34 - This tool assumes that the quality score is Phred+33, such as Sanger fastq.
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
35 - Reads that have either left or right flanking regions shorter than the length of flanking regions that require quality screening will be removed.
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
36
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
37 **Citation**
07588b899c13 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**
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
39
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
40 **Input**
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
41
2
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
42 The input file needs to be in the same format as output from **STR detection** step. This format contains **length of repeat**, **length of left flanking region**, **length of right flanking region**, **repeat motif**, **hamming (editing) distance**, **read name**, **read sequence**, **read quality score**
0
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
43
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
44 **Output**
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
45
2
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
46 The output will be two fastq files. The first file contains left flanking bases. The second file contains right flanking bases.
0
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
47
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
48 **Example**
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
49
2
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
50 - Starting with this test input ::
0
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
51
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
52 6 40 54 G 0 SRR345592.75000006 HS2000-192_107:1:63:5822:176818_1_per1_1 TACCCTCCTGTCTTCCCAGACTGATTTCTGTTCCTGCCCTggggggTTCTTGACTCCTCTGAATGGGTACGGGAGTGTGGACCTCAGGGAGGCCCCCTTG GGGGGGGGGGGGGGGGGFGGGGGGGGGFEGGGGGGGGGGG?FFDFGGGGGG?FFFGGGGGDEGGEFFBEFCEEBD@BACB*?=99(/=5'6=4:CCC*AA
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
53
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
54
2
d5ed5c2e25c3 Uploaded
arkarachai-fungtammasan
parents: 0
diff changeset
55 - If we want to get fastq files of flanking regions around the detected STRs with quality score of at least 20, the program will report these two fastq files ::
0
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
56
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
57 @SRR345592.75000006 HS2000-192_107:1:63:5822:176818_1_per1_1
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
58 TACCCTCCTGTCTTCCCAGACTGATTTCTGTTCCTGCCCT
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
59 +SRR345592.75000006 HS2000-192_107:1:63:5822:176818_1_per1_1
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
60 GGGGGGGGGGGGGGGGGFGGGGGGGGGFEGGGGGGGGGGG
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
61
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
62
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
63 @SRR345592.75000006 HS2000-192_107:1:63:5822:176818_1_per1_1
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
64 TTCTTGACTCCTCTGAATGGGTACGGGAGTGTGGACCTCAGGGAGGCCCCCTTG
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
65 +SRR345592.75000006 HS2000-192_107:1:63:5822:176818_1_per1_1
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
66 GGGGG?FFFGGGGGDEGGEFFBEFCEEBD@BACB*?=99(/=5'6=4:CCC*AA
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
67
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
68
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
69
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
70 </help>
07588b899c13 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
71 </tool>