annotate tools/blast2go/blast2go.xml @ 23:31cb702eb5a8 draft

Uploaded v0.0.9, embed citation, updated README
author peterjc
date Thu, 31 Jul 2014 05:40:57 -0400
parents
children 05eef6b222af
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
23
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
1 <tool id="blast2go" name="Blast2GO" version="0.0.9">
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
2 <description>Maps BLAST results to GO annotation terms</description>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
3 <requirements>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
4 <requirement type="package" version="2.5">b2g4pipe</requirement>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
5 </requirements>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
6 <command interpreter="python">
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
7 blast2go.py "${xml}" "${prop.fields.path}" "${tab}"
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
8 </command>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
9 <stdio>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
10 <!-- Wrapper ensures anything other than zero is an error -->
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
11 <exit_code range="1:" />
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
12 <exit_code range=":-1" />
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
13 </stdio>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
14 <inputs>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
15 <param name="xml" type="data" format="blastxml" label="BLAST XML results" description="You must have run BLAST against a protein database such as the NCBI non-redundant (NR) database. Use BLASTX for nucleotide queries, BLASTP for protein queries." />
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
16 <param name="prop" type="select" label="Blast2GO settings" description="One or more configurations can be setup, such as using the Blast2GO team's server in Spain, or a local database.">
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
17 <options from_file="blast2go.loc">
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
18 <column name="value" index="0"/>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
19 <column name="name" index="1"/>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
20 <column name="path" index="2"/>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
21 </options>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
22 </param>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
23 </inputs>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
24 <outputs>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
25 <data name="tab" format="tabular" label="Blast2GO ${prop.fields.name}" />
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
26 </outputs>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
27 <tests>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
28 <test>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
29 <param name="xml" value="blastp_sample.xml" ftype="blastxml"/>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
30 <param name="prop" value="Spain_2011_June"/>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
31 <output name="tab" file="blastp_sample.blast2go.tabular" ftype="tabular"/>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
32 </test>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
33 </tests>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
34 <help>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
35 .. class:: warningmark
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
36
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
37 **Note**. Blast2GO may take a substantial amount of time, especially if
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
38 running against the public server in Spain. For large input datasets it
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
39 is advisable to allow overnight processing, or consider subdividing.
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
40
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
41 -----
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
42
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
43 **What it does**
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
44
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
45 This runs b2g4Pipe v2.5, which is the command line (no GUI) version of
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
46 Blast2GO designed for use in pipelines.
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
47
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
48 It takes as input BLAST XML results against a protein database, typically
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
49 the NCBI non-redundant (NR) database. This tool will accept concatenated
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
50 BLAST XML files (although they are technically invalid XML), which is very
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
51 useful if you have sub-divided your protein FASTA files and run BLAST on
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
52 them in batches.
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
53
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
54 The BLAST matches are used to assign Gene Ontology (GO) annotation terms
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
55 to each query sequence.
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
56
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
57 The output from this tool is a tabular file containing three columns, with
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
58 the order taken from query order in the original BLAST XML file:
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
59
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
60 ====== ====================
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
61 Column Description
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
62 ------ --------------------
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
63 1 ID of query sequence
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
64 2 GO term
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
65 3 GO description
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
66 ====== ====================
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
67
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
68 Note that if no GO terms are assigned to a sequence (e.g. if it had no
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
69 BLAST matches), then it will not be present in the output file.
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
70
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
71 This tabular file is called an "Annotation File" in the Blast2GO GUI.
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
72 If you download the tabular file, and rename it to use the extension
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
73 ".annot", then it can be opened with the Blast2GO GUI via the "File",
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
74 "Load Annotation (.annot)" menu (keyboard shortcut ALT+L). You can
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
75 then run some of the interactive analyses offered in the GUI tool.
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
76
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
77
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
78 **Advanced Settings**
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
79
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
80 Blast2GO has a properties setting file which includes which database
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
81 server to connect to (e.g. the public server in Valencia, Spain, or a
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
82 local server), as well as more advanced options such as thresholds and
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
83 evidence code weights. To change these settings, your Galaxy administrator
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
84 must create a new properties file, and add it to the drop down menu above.
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
85
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
86
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
87 **References**
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
88
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
89 If you use this Galaxy tool in work leading to a scientific publication please
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
90 cite the following papers:
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
91
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
92 Peter Cock, Bjoern Gruening, Konrad Paszkiewicz and Leighton Pritchard (2013).
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
93 Galaxy tools and workflows for sequence analysis with applications
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
94 in molecular plant pathology. PeerJ 1:e167
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
95 http://dx.doi.org/10.7717/peerj.167
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
96
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
97 S. Götz et al. (2008).
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
98 High-throughput functional annotation and data mining with the Blast2GO suite.
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
99 Nucleic Acids Res. 36(10):3420–3435.
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
100 http://dx.doi.org/10.1093/nar/gkn176
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
101
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
102 A. Conesa and S. Götz (2008).
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
103 Blast2GO: A Comprehensive Suite for Functional Analysis in Plant Genomics.
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
104 International Journal of Plant Genomics. 619832.
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
105 http://dx.doi.org/10.1155/2008/619832
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
106
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
107 A. Conesa et al. (2005).
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
108 Blast2GO: A universal tool for annotation, visualization and analysis in functional genomics research.
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
109 Bioinformatics 21:3674-3676.
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
110 http://dx.doi.org/10.1093/bioinformatics/bti610
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
111
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
112 See also http://www.blast2go.com/
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
113
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
114 This wrapper is available to install into other Galaxy Instances via the Galaxy
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
115 Tool Shed at http://toolshed.g2.bx.psu.edu/view/peterjc/blast2go
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
116
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
117 </help>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
118 <citations>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
119 <citation type="doi">10.7717/peerj.167</citation>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
120 <citation type="doi">10.1093/nar/gkn176</citation>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
121 <citation type="doi">10.1155/2008/619832</citation>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
122 <citation type="doi">10.1093/bioinformatics/bti610</citation>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
123 </citations>
31cb702eb5a8 Uploaded v0.0.9, embed citation, updated README
peterjc
parents:
diff changeset
124 </tool>