Mercurial > repos > peterjc > blast_rbh
annotate tools/blast_rbh/blast_rbh.xml @ 14:40c85a67e645 draft
Uploaded v0.1.6, offer the new blastp-fast tasked added in BLAST+ 2.2.30.
| author | peterjc |
|---|---|
| date | Thu, 27 Nov 2014 11:41:08 -0500 |
| parents | 4454596ed127 |
| children | 904dfe4faae7 |
| rev | line source |
|---|---|
|
14
40c85a67e645
Uploaded v0.1.6, offer the new blastp-fast tasked added in BLAST+ 2.2.30.
peterjc
parents:
13
diff
changeset
|
1 <tool id="blast_reciprocal_best_hits" name="BLAST Reciprocal Best Hits (RBH)" version="0.1.6"> |
| 0 | 2 <description>from two FASTA files</description> |
| 3 <requirements> | |
| 12 | 4 <requirement type="package" version="1.64">biopython</requirement> |
| 5 <requirement type="python-module">Bio</requirement> | |
| 6 <requirement type="binary">makeblastdb</requirement> | |
| 7 <requirement type="binary">blastp</requirement> | |
| 8 <requirement type="binary">blastn</requirement> | |
| 13 | 9 <requirement type="package" version="2.2.30">blast+</requirement> |
| 0 | 10 </requirements> |
| 11 <version_command interpreter="python"> | |
| 12 blast_rbh.py --version | |
| 13 </version_command> | |
| 14 <command interpreter="python"> | |
|
8
d3eb5cda7270
Uploaded v0.1.2, self comparison and easier command line API
peterjc
parents:
7
diff
changeset
|
15 blast_rbh.py "$fasta_a" "$fasta_b" |
|
d3eb5cda7270
Uploaded v0.1.2, self comparison and easier command line API
peterjc
parents:
7
diff
changeset
|
16 -a $seq.dbtype |
| 0 | 17 #if $seq.dbtype=="nucl" |
|
8
d3eb5cda7270
Uploaded v0.1.2, self comparison and easier command line API
peterjc
parents:
7
diff
changeset
|
18 -t $seq.nucl_type |
| 0 | 19 #else |
|
8
d3eb5cda7270
Uploaded v0.1.2, self comparison and easier command line API
peterjc
parents:
7
diff
changeset
|
20 -t $seq.prot_type |
| 0 | 21 #end if |
| 12 | 22 $make_nr |
|
8
d3eb5cda7270
Uploaded v0.1.2, self comparison and easier command line API
peterjc
parents:
7
diff
changeset
|
23 -i $identity |
|
d3eb5cda7270
Uploaded v0.1.2, self comparison and easier command line API
peterjc
parents:
7
diff
changeset
|
24 -c $q_cover |
|
d3eb5cda7270
Uploaded v0.1.2, self comparison and easier command line API
peterjc
parents:
7
diff
changeset
|
25 -o "$output" |
| 0 | 26 </command> |
| 7 | 27 <stdio> |
| 28 <!-- Anything other than zero is an error --> | |
| 29 <exit_code range="1:" /> | |
| 30 <exit_code range=":-1" /> | |
| 31 </stdio> | |
| 0 | 32 <inputs> |
| 33 <!-- Galaxy does not have sub-types for protein vs nucletide FASTA --> | |
| 34 <param name="fasta_a" type="data" format="fasta" | |
| 35 label="Genes/proteins from species A" | |
| 36 description="FASTA file, one sequence per gene/protein." /> | |
| 37 <param name="fasta_b" type="data" format="fasta" | |
| 38 label="Genes/proteins from species B" | |
| 39 description="FASTA file, one sequence per gene/protein." /> | |
| 40 <conditional name="seq"> | |
| 41 <param name="dbtype" type="select" label="Molecule type of FASTA inputs"> | |
| 42 <option value="prot">protein</option> | |
| 43 <option value="nucl">nucleotide</option> | |
| 44 </param> | |
| 45 <when value="prot"> | |
| 46 <param name="prot_type" type="select" display="radio" label="Type of BLAST"> | |
| 47 <option value="blastp">blastp - Traditional BLASTP to compare a protein query to a protein database</option> | |
|
14
40c85a67e645
Uploaded v0.1.6, offer the new blastp-fast tasked added in BLAST+ 2.2.30.
peterjc
parents:
13
diff
changeset
|
48 <option value="blastp-fast">blastp-fast - Uses longer words as described by Shiryev et al (2007)</option> |
| 0 | 49 <option value="blastp-short">blastp-short - BLASTP optimized for queries shorter than 30 residues</option> |
| 50 </param> | |
| 51 </when> | |
| 52 <when value="nucl"> | |
| 53 <param name="nucl_type" type="select" display="radio" label="Type of BLAST"> | |
| 54 <option value="megablast">megablast - Traditional megablast used to find very similar (e.g., intraspecies or closely related species) sequences</option> | |
| 55 <option value="blastn">blastn - Traditional BLASTN requiring an exact match of 11, for somewhat similar sequences</option> | |
| 56 <option value="blastn-short">blastn-short - BLASTN program optimized for sequences shorter than 50 bases</option> | |
| 57 <option value="dc-megablast">dc-megablast - Discontiguous megablast used to find more distant (e.g., interspecies) sequences</option> | |
|
4
57245c11b8cb
Uploaded v0.1.0d, TBLASTX support; changed output columns
peterjc
parents:
2
diff
changeset
|
58 <option value="tblastx">tblastx - TBLASTX program using translated query against translated database (protein level matches)</option> |
| 0 | 59 </param> |
| 60 </when> | |
| 61 </conditional> | |
| 62 <param name="identity" type="float" value="70" min="0" max="100" | |
| 63 label="Minimum percentage identity for BLAST matches" | |
| 64 help="Default is 70%, use 0 for no filtering." /> | |
| 65 <param name="q_cover" type="float" value="50" min="0" max="100" | |
| 66 label="Minimum percentage query coverage for BLAST matches" | |
| 67 help="Default is 50%, use 0 for no filtering." /> | |
| 12 | 68 <param name="make_nr" type="boolean" checked="false" truevalue="--nr" falsevalue="" |
| 69 label="Process input FASTA files to collapse identical sequences" | |
| 70 help="i.e. First make the input non-redundant" /> | |
| 0 | 71 </inputs> |
| 72 <outputs> | |
| 73 <data name="output" format="tabular" label="BLAST RBH: $fasta_a.name vs $fasta_b.name" /> | |
| 74 </outputs> | |
| 75 <requirements> | |
| 76 </requirements> | |
| 77 <tests> | |
| 78 <test> | |
| 1 | 79 <param name="fasta_a" value="four_human_proteins.fasta" ftype="fasta"/> |
| 80 <param name="fasta_b" value="rhodopsin_proteins.fasta" ftype="fasta"/> | |
| 81 <param name="dbtype" value="prot"/> | |
| 82 <param name="nucl_type" value="blastp"/> | |
| 83 <param name="identity" value="0.0"/> | |
| 84 <param name="q_cover" value="0.0"/> | |
| 85 <output name="output" file="rbh_blastp_four_human_vs_rhodopsin_proteins.tabular" ftype="tabular"/> | |
| 86 </test> | |
| 87 <test> | |
| 0 | 88 <param name="fasta_a" value="rhodopsin_nucs.fasta" ftype="fasta"/> |
| 89 <param name="fasta_b" value="three_human_mRNA.fasta" ftype="fasta"/> | |
| 90 <param name="dbtype" value="nucl"/> | |
| 91 <param name="nucl_type" value="megablast"/> | |
| 92 <param name="identity" value="0.0"/> | |
| 93 <param name="q_cover" value="0.0"/> | |
| 94 <output name="output" file="rbh_megablast_rhodopsin_nucs_vs_three_human_mRNA.tabular" ftype="tabular"/> | |
| 95 </test> | |
| 96 <test> | |
| 97 <param name="fasta_a" value="rhodopsin_nucs.fasta" ftype="fasta"/> | |
| 98 <param name="fasta_b" value="three_human_mRNA.fasta" ftype="fasta"/> | |
| 99 <param name="dbtype" value="nucl"/> | |
| 100 <param name="nucl_type" value="megablast"/> | |
| 101 <param name="identity" value="92"/> | |
| 102 <param name="q_cover" value="86"/> | |
| 103 <output name="output" file="rbh_megablast_rhodopsin_nucs_vs_three_human_mRNA.tabular" ftype="tabular"/> | |
| 104 </test> | |
| 105 <!-- push the percentage identity over the 92.07% level --> | |
| 106 <test> | |
| 107 <param name="fasta_a" value="rhodopsin_nucs.fasta" ftype="fasta"/> | |
| 108 <param name="fasta_b" value="three_human_mRNA.fasta" ftype="fasta"/> | |
| 109 <param name="dbtype" value="nucl"/> | |
| 110 <param name="nucl_type" value="megablast"/> | |
| 111 <param name="identity" value="92.5"/> | |
| 112 <param name="q_cover" value="86"/> | |
| 113 <output name="output" file="rbh_none.tabular" ftype="tabular"/> | |
| 114 </test> | |
| 115 <!-- push the coverage over the 86% level --> | |
| 116 <test> | |
| 117 <param name="fasta_a" value="rhodopsin_nucs.fasta" ftype="fasta"/> | |
| 118 <param name="fasta_b" value="three_human_mRNA.fasta" ftype="fasta"/> | |
| 119 <param name="dbtype" value="nucl"/> | |
| 120 <param name="nucl_type" value="megablast"/> | |
| 121 <param name="identity" value="92"/> | |
| 122 <param name="q_cover" value="87"/> | |
| 123 <output name="output" file="rbh_none.tabular" ftype="tabular"/> | |
| 124 </test> | |
| 125 <test> | |
|
5
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
126 <param name="fasta_a" value="rhodopsin_nucs.fasta" ftype="fasta"/> |
|
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
127 <param name="fasta_b" value="three_human_mRNA.fasta" ftype="fasta"/> |
|
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
128 <param name="dbtype" value="nucl"/> |
|
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
129 <param name="nucl_type" value="tblastx"/> |
|
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
130 <param name="identity" value="0.0"/> |
|
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
131 <param name="q_cover" value="0.0"/> |
|
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
132 <output name="output" file="rbh_tblastx_rhodopsin_nucs_vs_three_human_mRNA.tabular" ftype="tabular"/> |
|
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
133 </test> |
|
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
134 <test> |
| 0 | 135 <param name="fasta_a" value="three_human_mRNA.fasta" ftype="fasta"/> |
| 136 <param name="fasta_b" value="rhodopsin_nucs.fasta" ftype="fasta"/> | |
| 137 <param name="dbtype" value="nucl"/> | |
| 138 <param name="nucl_type" value="blastn"/> | |
| 139 <param name="identity" value="0.0"/> | |
| 140 <param name="q_cover" value="0.0"/> | |
| 141 <output name="output" file="rbh_blastn_three_human_mRNA_vs_rhodopsin_nucs.tabular" ftype="tabular"/> | |
| 142 </test> | |
| 6 | 143 <!-- this pair of examples test tied best hits --> |
| 144 <test> | |
| 145 <param name="fasta_a" value="k12_ten_proteins.fasta" ftype="fasta"/> | |
| 146 <param name="fasta_b" value="k12_edited_proteins.fasta" ftype="fasta"/> | |
|
8
d3eb5cda7270
Uploaded v0.1.2, self comparison and easier command line API
peterjc
parents:
7
diff
changeset
|
147 <param name="dbtype" value="prot"/> |
| 6 | 148 <param name="nucl_type" value="blastp"/> |
| 149 <param name="identity" value="0.0"/> | |
| 150 <param name="q_cover" value="0.0"/> | |
| 151 <output name="output" file="rbh_blastp_k12.tabular" ftype="tabular"/> | |
| 152 </test> | |
| 153 <test> | |
| 154 <param name="fasta_a" value="k12_edited_proteins.fasta" ftype="fasta"/> | |
| 155 <param name="fasta_b" value="k12_ten_proteins.fasta" ftype="fasta"/> | |
|
8
d3eb5cda7270
Uploaded v0.1.2, self comparison and easier command line API
peterjc
parents:
7
diff
changeset
|
156 <param name="dbtype" value="prot"/> |
| 6 | 157 <param name="nucl_type" value="blastp"/> |
| 158 <param name="identity" value="0.0"/> | |
| 159 <param name="q_cover" value="0.0"/> | |
| 160 <output name="output" file="rbh_blastp_k12.tabular" ftype="tabular"/> | |
| 161 </test> | |
|
8
d3eb5cda7270
Uploaded v0.1.2, self comparison and easier command line API
peterjc
parents:
7
diff
changeset
|
162 <!-- this tests self-comparison --> |
|
d3eb5cda7270
Uploaded v0.1.2, self comparison and easier command line API
peterjc
parents:
7
diff
changeset
|
163 <test> |
|
d3eb5cda7270
Uploaded v0.1.2, self comparison and easier command line API
peterjc
parents:
7
diff
changeset
|
164 <param name="fasta_a" value="k12_edited_proteins.fasta" ftype="fasta"/> |
|
d3eb5cda7270
Uploaded v0.1.2, self comparison and easier command line API
peterjc
parents:
7
diff
changeset
|
165 <param name="fasta_b" value="k12_edited_proteins.fasta" ftype="fasta"/> |
|
d3eb5cda7270
Uploaded v0.1.2, self comparison and easier command line API
peterjc
parents:
7
diff
changeset
|
166 <param name="dbtype" value="prot"/> |
|
14
40c85a67e645
Uploaded v0.1.6, offer the new blastp-fast tasked added in BLAST+ 2.2.30.
peterjc
parents:
13
diff
changeset
|
167 <param name="nucl_type" value="blastp-fast"/> |
|
8
d3eb5cda7270
Uploaded v0.1.2, self comparison and easier command line API
peterjc
parents:
7
diff
changeset
|
168 <param name="identity" value="80.0"/> |
|
d3eb5cda7270
Uploaded v0.1.2, self comparison and easier command line API
peterjc
parents:
7
diff
changeset
|
169 <param name="q_cover" value="80.0"/> |
|
d3eb5cda7270
Uploaded v0.1.2, self comparison and easier command line API
peterjc
parents:
7
diff
changeset
|
170 <output name="output" file="rbh_blastp_k12_self.tabular" ftype="tabular"/> |
|
d3eb5cda7270
Uploaded v0.1.2, self comparison and easier command line API
peterjc
parents:
7
diff
changeset
|
171 </test> |
| 0 | 172 </tests> |
| 173 <help> | |
| 174 **What it does** | |
| 175 | |
| 2 | 176 Takes two FASTA files (*species A* and *species B*), builds a BLAST database |
| 0 | 177 for each, runs reciprocal BLAST searchs (*A vs B*, and *B vs A*), optionally |
| 2 | 178 filters the HSPs, and then compiles a list of the reciprocal best hits (RBH). |
| 0 | 179 |
|
5
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
180 The output from this tool is a tabular file containing multiple columns, with |
| 2 | 181 information about the BLAST matches used: |
| 0 | 182 |
|
5
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
183 ====== ================================== |
| 0 | 184 Column Description |
|
5
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
185 ------ ---------------------------------- |
| 2 | 186 1 ID from *species A* |
| 187 2 ID from *species B* | |
|
5
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
188 3 Length of sequence *A* |
|
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
189 4 Length of sequence *B* |
|
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
190 5 Percentage of sequence *A* covered |
|
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
191 6 Percentage of sequence *B* covered |
|
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
192 7 HSP alignment length |
|
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
193 8 HSP percentage identity |
|
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
194 9 HSP bitscore |
|
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
195 ====== ================================== |
| 2 | 196 |
|
5
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
197 These values correspond to the ``qseqid``/``sseqid``, ``qlen``/``slen``, |
|
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
198 ``qcovhsp``, ``length``, ``pident`` and ``bitscore`` values in the BLAST+ |
|
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
199 tabular output. |
|
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
200 |
|
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
201 For the alignment length, bitscore and percentage identity the values for |
|
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
202 *A vs B* and *B vs A* are typically the same, so their minimum is shown. |
|
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
203 The coverage values are given by the HSP alignment length divided by the |
|
c84b6c21e3d4
Uploaded v0.1.0e, test TBLASTX mode; more columns in output
peterjc
parents:
4
diff
changeset
|
204 sequence length (adjusted by a factor of three for TBLASTX). |
| 0 | 205 |
| 6 | 206 Note that if a sequence has equally scoring top BLAST matches to multiple |
| 207 sequence in the other file, it will not be considered for an RBH. This | |
| 208 can happen following gene duplication, or for (near) identical gene | |
| 209 duplicates. | |
| 210 | |
| 12 | 211 The tool can optionally make the FASTA files non-redundant by replacing |
| 212 repeated identical sequences with a single representative before building | |
| 213 the databases and running BLAST. | |
| 214 | |
| 215 Finally, the tool can be run using the same FASTA input file to look for | |
| 216 RBH within the dataset. In this case, self matches are discarded. | |
| 217 | |
| 0 | 218 .. class:: warningmark |
| 219 | |
| 220 **Note** | |
| 221 | |
| 222 If you are trying to use BLAST RBH matches to identify candidate orthologues | |
| 223 or transfer annotation, you *must* use a percentage identity and minimum | |
| 224 coverage threshold or similiar. See: | |
| 225 | |
| 226 Punta and Ofran (2008) The Rough Guide to In Silico Function Prediction, | |
| 227 or How To Use Sequence and Structure Information To Predict Protein | |
| 228 Function. PLoS Comput Biol 4(10): e1000160. | |
| 229 http://dx.doi.org/10.1371/journal.pcbi.1000160 | |
| 230 | |
| 231 The defaults are to require 70% sequence identity over the aligned region | |
| 232 (using ``pident`` in the BLAST+ tabular output), and that the HSP alignment | |
| 233 covers at least 50% of the query sequence (using ``qcovhsp`` in the BLAST+ | |
| 234 tabular output). | |
| 235 | |
| 236 | |
| 237 **References** | |
| 238 | |
| 239 A specific paper covering this tool is planned, but please also cite: | |
| 240 | |
| 241 Christiam Camacho et al. (2009). | |
| 242 BLAST+: architecture and applications. | |
| 243 BMC Bioinformatics. 15;10:421. | |
| 244 http://dx.doi.org/10.1186/1471-2105-10-421 | |
| 245 | |
| 246 This wrapper is available to install into other Galaxy Instances via the Galaxy | |
| 247 Tool Shed at http://toolshed.g2.bx.psu.edu/view/peterjc/blast_rbh | |
| 248 </help> | |
| 10 | 249 <citations> |
| 250 <citation type="doi">10.1186/1471-2105-10-421</citation> | |
| 251 <!-- TODO: Add BibTeX entry / preprint DOI for Galaxy BLAST+ paper --> | |
| 252 </citations> | |
| 0 | 253 </tool> |