annotate fetchflank.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="fetchflank" name="Fetch flanking bases" version="1.0.0">
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
2 <description> of microsatellites and output as two fastq files in forward-forward orientation</description>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
3 <command interpreter="python">pair_fetch_DNA_ff.py $microsat_in_read $Leftflanking $Rightflanking $qualitycutoff $lengthofbasetocheckquality </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="microsat_in_read" type="data" label="Select data of microsatellites in reads" />
70f8259b0b30 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" />
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
8 <param name="lengthofbasetocheckquality" type="integer" value="20" label="Length of flanking regions that require quality screening" />
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="fastq" name="Leftflanking" />
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
12 <data format="fastq" name="Rightflanking" />
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="microsat_in_read" value="samplefq.snoope"/>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
18 <param name="qualitycutoff" value="20"/>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
19 <param name="lengthofbasetocheckquality" value="20"/>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
20 <output name="Leftflanking" file="microsatellite_flanking_L.fastq"/>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
21 <output name="Rightflanking" file="microsatellite_flanking_R.fastq"/>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
22 </test>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
23
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
24 </tests>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
25 <help>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
26
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
27
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
28 .. class:: infomark
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
29
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
30 **What it does**
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
31
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
32 This tool will fetch flanking regions around microsatellites, screen for quality score at microsatellites and adjacent flanking regions, and output two fastq files containing flanking regions in forward-forward direction.
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
33
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
34 - This tool assumes that the quality score is Phred+33, such as Sanger fastq.
70f8259b0b30 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.
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
36
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
37 **Citation**
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 The input files need to be in the same format as output from **microsatellite detection program**. 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**
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 be the two fastq files. The first file contains left flank regions. The second file contains right flanking regions.
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
47
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
48 **Example**
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
49
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
50 - Suppose we detected the microsatellites from short reads ::
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
51
70f8259b0b30 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
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
53
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
54
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
55 - We want to get fastq files of flanking regions around microsatellite with quality score at least 20 on Phred +33
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
56
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
57 - Then the program will report these two fastq files ::
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
58
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
59 @SRR345592.75000006 HS2000-192_107:1:63:5822:176818_1_per1_1
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
60 TACCCTCCTGTCTTCCCAGACTGATTTCTGTTCCTGCCCT
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
61 +SRR345592.75000006 HS2000-192_107:1:63:5822:176818_1_per1_1
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
62 GGGGGGGGGGGGGGGGGFGGGGGGGGGFEGGGGGGGGGGG
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
63
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
64
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
65 @SRR345592.75000006 HS2000-192_107:1:63:5822:176818_1_per1_1
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
66 TTCTTGACTCCTCTGAATGGGTACGGGAGTGTGGACCTCAGGGAGGCCCCCTTG
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
67 +SRR345592.75000006 HS2000-192_107:1:63:5822:176818_1_per1_1
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
68 GGGGG?FFFGGGGGDEGGEFFBEFCEEBD@BACB*?=99(/=5'6=4:CCC*AA
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
69
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
70
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
71
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
72 </help>
70f8259b0b30 Uploaded
arkarachai-fungtammasan
parents:
diff changeset
73 </tool>