annotate tools/solid_tools/maq_cs_wrapper.xml @ 2:c2a356708570

Uploaded
author xuebing
date Fri, 09 Mar 2012 19:45:42 -0500
parents 9071e359b9a3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
1 <tool id="maq_cs_wrapper" name="MAQ for SOLiD" version="1.0.0">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description> </description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <command interpreter="python">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 maq_cs_wrapper.py
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 $output1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 $output2
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 $ref
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8 $library_type.f3_reads
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 $library_type.f3_qual
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 $library_type.is_paired
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 #if $library_type.is_paired == "yes":
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 $library_type.r3_reads
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 $library_type.r3_qual
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 #else:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 "None"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 "None"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 #end if
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 $min_mapqual
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 $max_mismatch
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 $output3
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 </command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 <param name="ref" type="data" format="fasta" label="Target Genome"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 <conditional name="library_type">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 <param name="is_paired" type="select" label="Is the library mate-paired?" multiple="false">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 <option value="no">No</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 <option value="yes">Yes</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 <when value="no">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32 <param name="f3_reads" type="data" format="csfasta" label="F3 reads file"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 <param format="qualsolid" name="f3_qual" type="data" label="F3 quality file" help="If your dataset doesn't show up in the menu, click the pencil icon next to your dataset and set the datatype to 'qualsolid'" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 <when value="yes">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36 <param name="f3_reads" type="data" format="csfasta" label="F3 reads file"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 <param format="qualsolid" name="f3_qual" type="data" label="F3 quality file" help="If your dataset doesn't show up in the menu, click the pencil icon next to your dataset and set the datatype to 'qualsolid'" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38 <param name="r3_reads" type="data" format="csfasta" label="R3 reads file"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39 <param format="qualsolid" name="r3_qual" type="data" label="R3 quality file" help="If your dataset doesn't show up in the menu, click the pencil icon next to your dataset and set the datatype to 'qualsolid'" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41 </conditional>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42 <param name="min_mapqual" type="integer" size="3" value="0" label="Minimum mapping quality allowed for a read to be used" help="Reads below the specified mapping quality will not be considered in coverage and SNP analysis."/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43 <param name="max_mismatch" type="integer" size="3" value="7" label="Maximum number of mismatches allowed for a read to be used" help="Reads above the specified threshold will not be considered in coverage and SNP analysis."/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46 <data format="tabular" name="output1" metadata_source="ref" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47 <data format="tabular" name="output2" metadata_source="ref" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48 <data format="customtrack" name="output3" metadata_source="ref" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51 <!-- "ToolTestCase does not deal with multiple outputs properly yet."
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55 <param name="ref" value="phiX_mod.fasta" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56 <param name="is_paired" value="no" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57 <param name="f3_reads" value="phiX_solid.csfasta" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58 <param name="f3_qual" value="phiX_solid.qualsolid" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 <param name="min_mapqual" value="0" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60 <param name="max_mismatch" value="7" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61 <output name="output1" file="phiX_solid_maq.map" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62 <output name="output2" file="phiX_solid_maq.pileup" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63 <output name="output3" file="phiX_solid_maq.ctrack" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67 -->
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
70 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
71
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
72 **What it does**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
73
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
74 This tool maps SOLiD color-space reads against the target genome using MAQ. It produces three output datasets:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
75
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
76
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
77 **ALIGNMENT INFO** : contains the read alignment information,
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
78
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
79 **PILEUP** : contains the coverage and SNP statistics for every nucleotide of the target genome,
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
80
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
81 **CUSTOM TRACK** : contains the coverage and SNP statistics as custom tracks displayable in the UCSC browser.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
82
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
83 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
84
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
85 **The ALIGNMENT INFO dataset will contain the following fields:**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
86
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
87 * column 1 = read name
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
88 * column 2 = chromosome
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
89 * column 3 = position
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
90 * column 4 = strand
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
91 * column 5 = insert size from the outer coorniates of a pair
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
92 * column 6 = paired flag
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
93 * column 7 = mapping quality
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
94 * column 8 = single-end mapping quality
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
95 * column 9 = alternative mapping quality
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
96 * column 10 = number of mismatches of the best hit
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
97 * column 11 = sum of qualities of mismatched bases of the best hit
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
98 * column 12 = number of 0-mismatch hits of the first 24bp
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
99 * column 13 = number of 1-mismatch hits of the first 24bp on the reference
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
100 * column 14 = length of the read
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
101 * column 15 = read sequence
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
102 * column 16 = read quality
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
103
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
104
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
105 **The PILEUP dataset will contain the following fields:**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
106
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
107 * column 1 = chromosome
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
108 * column 2 = position
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
109 * column 3 = reference nucleotide
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
110 * column 4 = coverage (number of reads that cover this position)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
111 * column 5 = number of SNPs
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
112 * column 6 = number of As
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
113 * column 7 = number of Ts
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
114 * column 8 = number of Gs
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
115 * column 9 = number of Cs
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
116
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
117 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
118 <code file="maq_cs_wrapper_code.py"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
119
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
120 </tool>