annotate blat_wrapper.xml @ 0:3cec538aab33 draft

Uploaded
author joachim-jacob
date Thu, 30 May 2013 07:13:55 -0400
parents
children da4426cac227
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
1 <tool id="blat" name="Align sequences with BLAT" version="1.0.0">
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
2 <!-- Additional info: wrapper compatible with versions ..... -->
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
3 <description>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
4 to a reference genome
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
5 </description>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
6
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
7 <version_command/>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
8
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
9 <requirements>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
10 <requirement type="package" version="1.0.0">blat</requirement>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
11 </requirements>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
12
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
13 <command interpreter="perl">
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
14 ## it is recommended that you write a wrapper for your tool
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
15 ## and pass all parameters to that tool, which parses them.
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
16 blat_wrapper.pl $configfile
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
17
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
18 </command>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
19
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
20 <inputs>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
21 <param format="fasta" name="input" type="data" label="Query fasta sequences" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
22 <param name="q" type="select" label="Process the query as">
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
23 <option value="dna" selected="True">DNA</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
24 <option value="rna">RNA</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
25 <option value="prot">Protein</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
26 <option value="dnax">DNA sequence translated in six frames to protein</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
27 <option value="rnax">RNA sequence translated in six frames to protein</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
28 </param>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
29 <conditional name="refGenomeSource">
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
30 <param name="genomeSource" type="select" label="Will you select a sequence database from your history or use a built-in index?" help="Built-ins were indexed using default options">
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
31 <option value="indexed">Use a built-in index</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
32 <option value="history" selected="True">Use one from the history</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
33 </param>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
34 <when value="indexed">
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
35 <param name="index" type="select" label="Select a reference genome" help="If your genome of interest is not listed, contact the Galaxy team">
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
36 <options from_data_table="twobit.loc">
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
37 <filter type="sort_by" column="1"/>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
38 <validator type="no_options" message="No indexes are available for the selected input dataset"/>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
39 </options>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
40 <param name="range" type="text" size="25" value="" label="Restrict the search space to this genomic range in the sequence database" help="Format = 'chr1:250000-260000' (i.e. name:startposition-endposition)" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
41
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
42 </param>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
43 </when>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
44 <when value="history">
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
45 <param name="ownFile" type="data" format="fasta" metadata_name="dbkey" label="Select the sequence database" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
46 </when> <!-- history -->
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
47 </conditional> <!-- refGenomeSource -->
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
48
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
49 <param name="t" type="select" label="Process the sequence database as">
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
50 <option value="dna" selected="True">DNA</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
51 <option value="prot">Protein</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
52 <option value="dnax">DNA sequence translated in six frames to protein</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
53 </param>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
54
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
55 <conditional name="advanced_params">
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
56 <param name="use" type="select" label="Show advanced parameters">
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
57 <option value="no" selected="True">No</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
58 <option value="yes">Yes</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
59 </param>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
60 <when value="no" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
61 <when value="yes" >
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
62 <param name="tileSize" type="text" size="3" value="11" label="size of match that triggers an alignment" help="Usually between 8 and 12. Default is 11 for DNA and 5 for protein." />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
63 <param name="stepSize" type="text" size="3" value="11" label="spacing between tiles" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
64 <param name="oneOff" type="boolean" truevalue="1" falsevalue="0" checked="False" label="Allowing one mismatch in tile?" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
65 <param name="minMatch" type="select" label="number of tile matches" >
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
66 <option value="1">1 (for proteins)</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
67 <option value="2" selected="True">2</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
68 <option value="3">3</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
69 <option value="4">4</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
70 </param>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
71 <param name="minScore" type="text" size="3" value="30" label="minimum score" help="This is the matches minus the mismatches minus some sort of gap penalty. Default is 30" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
72 <param name="maxGap" type="select" label="size of maximum gap between tiles in a clump" help=" Usually set from 0 to 3. Default is 2. Only relevent for minMatch > 1">
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
73 <option value="0">0</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
74 <option value="1">1</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
75 <option value="2" selected="True">2</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
76 <option value="3">3</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
77 </param>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
78 <param name="mask" type="select" label="Mask out repeats in reference sequence" help="Alignments won't be started in masked region but may extend through it in nucleotide searches. Masked areas are ignored entirely in protein or translated searches.">
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
79 <option value="lower">mask out lower cased sequence</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
80 <option value="upper">mask out upper cased sequence</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
81 </param>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
82 <param name="qMask" type="select" label="Mask out repeats in query sequence" help="Alignments won't be started in masked region but may extend through it in nucleotide searches. Masked areas are ignored entirely in protein or translated searches.">
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
83 <option value="lower">mask out lower cased sequence</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
84 <option value="upper">mask out upper cased sequence</option>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
85 </param>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
86 <param name="repeats" type="boolean" truevalue="yes" falsevalue="no" checked="False" label="Report matches in repeats separately?" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
87 <param name="trimT" type="boolean" truevalue="yes" falsevalue="no" checked="False" label="Trim leading poly-T" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
88 <param name="noTrimA" type="boolean" truevalue="no" falsevalue="yes" checked="True" label="Trim trailing poly-A" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
89 <param name="fine" type="boolean" truevalue="yes" falsevalue="no" checked="False" label="For high quality mRNAs look harder for small initial and terminal exons. Not recommended for ESTs" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
90 <param name="maxIntron" type="text" size="10" value="750000" label="Maximum intron size" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
91 <param name="extendThroughN" type="boolean" truevalue="yes" falsevalue="no" checked="False" label="Extent alignment through large blocks of N's? Not recommended for ESTs" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
92 </when>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
93 </conditional>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
94 </inputs>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
95
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
96 <outputs>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
97 <data format="tabular" name="output" label="${tool.name} on ${on_string}: alignments"/>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
98 </outputs>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
99
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
100 <configfiles>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
101 <!-- this config file collects all parameter settings -->
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
102 <configfile name="configfile">
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
103 ## first we pass some galaxy environment variables
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
104 galtemp==${__new_file_path__}
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
105
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
106 #if $refGenomeSource.genomeSource == "indexed"
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
107 referencepath==${refGenomeSource.index.fields.path}
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
108 range=$refGenomeSource.range
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
109 #else
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
110 referencepath==${refGenomeSource.ownFile}
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
111 #end if
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
112
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
113 input==$input
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
114 output==$output
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
115 q==$q
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
116 t==$t
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
117
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
118 advanced_params.use==$advanced_params.use
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
119 #if $advanced_params.use=="yes"
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
120 tileSize==$advanced_params.tileSize
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
121 stepSize==$advanced_params.stepSize
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
122 oneOff==$advanced_params.oneOff
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
123 minMatch==$advanced_params.minMatch
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
124 minScore==$advanced_params.minScore
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
125 maxGap==$advanced_params.maxGap
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
126 mask==$advanced_params.mask
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
127 qMask==$advanced_params.qMask
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
128 repeats==$advanced_params.repeats
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
129 trimT==$advanced_params.trimT
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
130 noTrimA==$advanced_params.noTrimA
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
131 fine==$advanced_params.fine
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
132 maxIntron==$advanced_params.maxIntron
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
133 extendThroughN==$advanced_params.extendThroughN
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
134 #end if
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
135
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
136 </configfile>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
137 </configfiles>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
138
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
139 <tests>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
140 <test>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
141 <param name="input" value="input83.fas" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
142 <param name="refGenomeSource.genomeSource" value="history" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
143 <param name="refGenomeSource.ownFile" value="databasetest1.txt" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
144 <param name="q" value="dna" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
145 <param name="t" value="dna" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
146 <param name="advanced_params.use" value="yes" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
147 <param name="advanced_params.tileSize" value="11" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
148 <param name="advanced_params.stepSize" value="11" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
149 <param name="advanced_params.oneOff" value="0" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
150 <param name="advanced_params.minMatch" value="2" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
151 <param name="advanced_params.minScore" value="30" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
152 <param name="advanced_params.maxGap" value="2" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
153 <param name="advanced_params.mask" value="lower" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
154 <param name="advanced_params.qMask" value="lower" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
155 <param name="advanced_params.repeats" value="no" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
156 <param name="advanced_params.trimT" value="no" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
157 <param name="advanced_params.noTrimA" value="yes" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
158 <param name="advanced_params.fine" value="no" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
159 <param name="advanced_params.maxIntron" value="750000" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
160 <param name="advanced_params.extendThroughN" value="no" />
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
161 <output name="output" file="outputtest1.txt" lines_diff="2"/>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
162 </test>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
163 </tests>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
164
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
165 <help>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
166 **BLAT Overview**
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
167
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
168 BLAT_ is an alignment tool like BLAST, but it is structured differently.
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
169 On DNA, Blat works by keeping an index of an entire genome in memory.
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
170 Thus, the target database of BLAT is not a set of GenBank sequences, but
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
171 instead an index derived from the assembly of the entire genome. By
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
172 default, the index consists of all non-overlapping 11-mers except for
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
173 those heavily involved in repeats.
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
174
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
175 .. _BLAT: http://genome.ucsc.edu/FAQ/FAQblat.html
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
176
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
177 </help>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
178 </tool>
3cec538aab33 Uploaded
joachim-jacob
parents:
diff changeset
179