Mercurial > repos > devteam > ncbi_blast_plus

annotate tools/ncbi_blast_plus/ncbi_blastdbcmd_wrapper.xml @ 3:e98f6bd363ba draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/ncbi_blast_plus commit a567843bb239ee8faec72eb7e52f3b5aa3191631
author peterjc
date Fri, 15 May 2015 06:15:59 -0400
parents 6119ddccd8a3
children 188d2aca045b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
e98f6bd363ba planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/ncbi_blast_plus commit a567843bb239ee8faec72eb7e52f3b5aa3191631
peterjc
parents: 2
diff changeset
1 <tool id="ncbi_blastdbcmd_wrapper" name="NCBI BLAST+ blastdbcmd entry(s)" version="0.1.03">
0
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
2 <description>Extract sequence(s) from BLAST database</description>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
3 <macros>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
4 <token name="@BINARY@">blastdbcmd</token>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
5 <import>ncbi_macros.xml</import>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
6 </macros>
3
e98f6bd363ba planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/ncbi_blast_plus commit a567843bb239ee8faec72eb7e52f3b5aa3191631
peterjc
parents: 2
diff changeset
7 <expand macro="preamble" />
0
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
8 <command>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
9 ## The command is a Cheetah template which allows some Python based syntax.
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
10 ## Lines starting hash hash are comments. Galaxy will turn newlines into spaces
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
11 blastdbcmd -dbtype $db_opts.db_type -db "${db_opts.database.fields.path}"
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
12
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
13 ##TODO: What about -ctrl_a and -target_only as advanced options?
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
14
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
15 #if $id_opts.id_type=="file":
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
16 -entry_batch "$id_opts.entries"
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
17 #else:
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
18 ##Perform some simple search/replaces to remove whitespace
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
19 ##and make it comma separated, and escape any pipe characters
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
20 -entry "$id_opts.entries.replace('\r',',').replace('\n',',').replace(' ','').replace(',,',',').replace(',,',',').strip(',').replace('|','\|')"
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
21 #end if
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
22
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
23 ##When building a BLAST database, to ensure unique IDs makeblastdb will
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
24 ##do things like turning a FASTA entry with ID of ERP44 into lcl|ERP44
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
25 ##(if using -parse_seqids) or simply assign it an ID using the record
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
26 ##number like gnl|BL_ORD_ID|123 (to cope with duplicate IDs in the FASTA
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
27 ##file). In -parse_seqids mode, a duplicate FASTA ID gives an error.
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
28 ##
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
29 ##The BLAST plain text and XML output will contain these BLAST IDs, but
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
30 ##the tabular output does not (at least, not in BLAST 2.2.25+).
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
31 ##Therefore in general, Galaxy users won't care about the (internal)
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
32 ##BLAST identifiers.
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
33 ##
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
34 ##The blastdbcmd FASTA output will also contain these IDs, but in the
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
35 ##context of the BLAST tabular output they are not helpful. Therefore
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
36 ##to recover the original ID as used in the FASTA file for makeblastdb
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
37 ##we need a litte post processing.
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
38 ##
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
39 ##We remove the NCBI's lcl|... or gnl|BL_ORD_ID|123 prefixes
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
40 ##using sed, however the exact syntax differs for Mac OS X's sed
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
41
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
42 #if str($outfmt)=="blastid":
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
43 -out "$seq"
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
44 #else if sys.platform == "darwin":
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
45 | sed -E 's/^>(lcl\||gnl\|BL_ORD_ID\|[0-9]* )/>/1' > "$seq"
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
46 #else:
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
47 | sed 's/>\(lcl|\|gnl|BL_ORD_ID|[0-9]* \)/>/1' > "$seq"
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
48 #end if
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
49 </command>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
50 <inputs>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
51 <expand macro="input_conditional_choose_db_type" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
52 <conditional name="id_opts">
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
53 <param name="id_type" type="select" label="Type of identifier list">
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
54 <option value="file">From file</option>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
55 <option value="prompt">User entered</option>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
56 </param>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
57 <when value="file">
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
58 <param name="entries" type="data" format="txt,tabular" label="Sequence identifier(s)" help="Plain text file with one ID per line (i.e. single column tabular file)"/>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
59 </when>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
60 <when value="prompt">
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
61 <param name="entries" type="text" label="Sequence identifier(s)" help="Comma or new line separated list." optional="False" area="True" size="10x30"/>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
62 </when>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
63 </conditional>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
64 <param name="outfmt" type="select" label="Output format">
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
65 <option value="original">FASTA with original identifiers</option>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
66 <option value="blastid">FASTA with BLAST assigned identifiers</option>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
67 </param>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
68 </inputs>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
69 <outputs>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
70 <data name="seq" format="fasta" label="Sequences from ${db_opts.database.fields.name}" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
71 </outputs>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
72 <tests>
2
6119ddccd8a3 Uploaded v0.1.02 preview 3, disable tests using blastdb*.loc since not supported on the ToolShed (yet).
peterjc
parents: 0
diff changeset
73 <!-- Disable for ToolShed where *.loc tests not yet supported
6119ddccd8a3 Uploaded v0.1.02 preview 3, disable tests using blastdb*.loc since not supported on the ToolShed (yet).
peterjc
parents: 0
diff changeset
74 See https://github.com/peterjc/galaxy_blast/issues/53
0
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
75 <test>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
76 <param name="db_opts|db_type" value="prot" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
77 <param name="db_opts|database" value="four_human_proteins" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
78 <param name="id_opts|id_type" value="prompt" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
79 <param name="id_opts|entries" value="all" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
80 <param name="outfmt" value="original" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
81 <output name="seq" file="four_human_proteins.fasta" ftype="fasta" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
82 </test>
2
6119ddccd8a3 Uploaded v0.1.02 preview 3, disable tests using blastdb*.loc since not supported on the ToolShed (yet).
peterjc
parents: 0
diff changeset
83 -->
0
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
84 </tests>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
85 <help>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
86
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
87 **What it does**
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
88
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
89 Extracts FASTA formatted sequences from a BLAST database
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
90 using the NCBI BLAST+ blastdbcmd command line tool.
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
91
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
92 .. class:: warningmark
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
93
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
94 **BLAST assigned identifiers**
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
95
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
96 When a BLAST database is constructed from a FASTA file, the
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
97 original identifiers can be replaced with BLAST assigned
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
98 identifiers, partly to ensure uniqueness. e.g. Sometimes
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
99 a prefix of 'lcl|' is added (lcl is short for local),
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
100 or an arbitrary name starting 'gnl|BL_ORD_ID|' is created.
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
101
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
102 If you are using the tabular output from BLAST, it will contain
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
103 the original identifiers - not the BLAST assigned identifiers
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
104 suitable for use with the blastdbcmd tool.
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
105
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
106 If you are using the XML or plain text output, this will also
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
107 contain the BLAST assigned identifiers. However, this means
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
108 getting a list of BLAST assigned identifiers isn't straightforward.
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
109
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
110 -------
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
111
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
112 **References**
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
113
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
114 If you use this Galaxy tool in work leading to a scientific publication please
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
115 cite the following papers:
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
116
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
117 @REFERENCES@
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
118 </help>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
119 <expand macro="blast_citations" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
120 </tool>