annotate tools/ncbi_blast_plus/blastxml_to_top_descr.xml @ 0:075fe5424c32 draft

Uploaded v0.0.1
author peterjc
date Thu, 07 Feb 2013 14:56:18 -0500
parents
children 662fea0fe6b2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
1 <tool id="blastxml_to_top_descr" name="BLAST top hit descriptions" version="0.0.1">
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
2 <description>Make a table from BLAST XML</description>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
3 <command interpreter="python">
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
4 blastxml_to_top_descr.py $blastxml_file $tabular_file $topN
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
5 </command>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
6 <inputs>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
7 <param name="blastxml_file" type="data" format="blastxml" label="BLAST results as XML"/>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
8 <param name="topN" type="integer" min="1" max="100" optional="false" label="Number of descriptions" value="3"/>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
9 </inputs>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
10 <outputs>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
11 <data name="tabular_file" format="tabular" label="Top $topN descriptions from $blastxml_file.name" />
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
12 </outputs>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
13 <requirements>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
14 </requirements>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
15 <tests>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
16 <test>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
17 <param name="blastxml_file" value="blastp_four_human_vs_rhodopsin.xml" ftype="blastxml" />
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
18 <param name="topN" value="3" />
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
19 <output name="tabular_file" file="blastp_four_human_vs_rhodopsin_top3.tabular" ftype="tabular" />
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
20 </test>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
21 </tests>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
22 <help>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
23
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
24 **What it does**
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
25
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
26 NCBI BLAST+ (and the older NCBI 'legacy' BLAST) can output in a range of
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
27 formats including text, tabular and a more detailed XML format. You can
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
28 do a lot of things with tabular files in Galaxy (sorting, filtering, joins,
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
29 etc) however currently the BLAST tabular output omits the hit descriptions
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
30 found in the other output formats.
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
31
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
32 This tool turns a BLAST XML file into a simple tabular file containing
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
33 one row per query sequence, containing the query identifier and then
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
34 the three (by default) top hit descriptions. If a query doesn't have
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
35 that many hits, then these entries are left blank.
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
36
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
37 **Example Usage**
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
38
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
39 One simple usage would be to take a transcriptome assembly or set of
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
40 gene predictions, run a BLAST search against the NCBI NR database, and
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
41 then use this tool to make a table of the top three BLAST hits. This
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
42 can give you a 'quick and dirty' crude annotation, potentially enough
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
43 to spot some problems (e.g. bacterial contaimination could be very
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
44 obvious).
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
45
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
46 </help>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
47 </tool>