annotate tools/ncbi_blast_plus/ncbi_segmasker_wrapper.xml @ 31:13aa389f4eeb draft

planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 16ef84e19ea373838bbfb921b9ef2cd4b02b8788-dirty
author peterjc
date Mon, 28 May 2018 07:57:56 -0400
parents 771b554bc85d
children 00330a63ffcf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
856b73016ba1 v0.1.05 - Update citation information now GigaScience paper is out
peterjc
parents: 5
diff changeset
1 <tool id="ncbi_segmasker_wrapper" name="NCBI BLAST+ segmasker" version="@WRAPPER_VERSION@">
0
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
2 <description>low-complexity regions in protein sequences</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@">segmasker</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: 0
diff changeset
7 <expand macro="preamble" />
20
c5f20ca77de2 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit de1ad30e756a7073c422d5677fe5c6750521fa1b-dirty
peterjc
parents: 12
diff changeset
8 <command detect_errors="aggressive">
0
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 segmasker
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
12 #if $db_opts.db_opts_selector == "db":
20
c5f20ca77de2 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit de1ad30e756a7073c422d5677fe5c6750521fa1b-dirty
peterjc
parents: 12
diff changeset
13 -in '${db_opts.database.fields.path}' -infmt blastdb
0
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
14 #elif $db_opts.db_opts_selector == "histdb":
20
c5f20ca77de2 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit de1ad30e756a7073c422d5677fe5c6750521fa1b-dirty
peterjc
parents: 12
diff changeset
15 -in '${os.path.join($db_opts.histdb.files_path, "blastdb")}' -infmt blastdb
0
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
16 #else:
20
c5f20ca77de2 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit de1ad30e756a7073c422d5677fe5c6750521fa1b-dirty
peterjc
parents: 12
diff changeset
17 -in '$subject' -infmt fasta
0
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
18 #end if
20
c5f20ca77de2 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit de1ad30e756a7073c422d5677fe5c6750521fa1b-dirty
peterjc
parents: 12
diff changeset
19 -out '$outfile'
0
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
20 -window $window
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
21 -locut $locut
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
22 -hicut $hicut
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
23 -outfmt $outformat
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
24 </command>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
25 <inputs>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
26 <expand macro="input_conditional_protein_db" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
27 <param name="window" type="integer" value="12" label="SEG window length" help="(-window)" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
28 <param name="locut" type="float" value="2.2" label="SEG low cutoff" help="(-locut)" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
29 <param name="hicut" type="float" value="2.5" label="SEG high cutoff" help="(-hicut)" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
30 <param name="outformat" 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
31 <!-- seqloc_* formats are not very useful
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
32 and what BLAST+ calls 'interval' is not what Galaxy calls interval format
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 <option value="fasta">FASTA</option>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
35 <option value="maskinfo_asn1_bin">maskinfo ASN.1 binary</option>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
36 <option value="maskinfo_asn1_text" selected="true">maskinfo ASN.1 text</option>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
37 <option value="maskinfo_xml">maskinfo_xml</option>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
38 </param>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
39 </inputs>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
40 <outputs>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
41 <data name="outfile" format="maskinfo-asn1" label="SEG Masked File">
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
42 <change_format>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
43 <when input="outformat" value="fasta" format="fasta" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
44 <when input="outformat" value="maskinfo_asn1_bin" format="maskinfo-asn1-binary" />
21
771b554bc85d planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 39737c01a51469d0cf9920273de6c151ba84048d-dirty
peterjc
parents: 20
diff changeset
45 <!--
0
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
46 <when input="outformat" value="maskinfo_asn1_text" format="maskinfo-asn1" />
21
771b554bc85d planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 39737c01a51469d0cf9920273de6c151ba84048d-dirty
peterjc
parents: 20
diff changeset
47 -->
0
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
48 <when input="outformat" value="maskinfo_xml" format="xml" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
49 </change_format>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
50 </data>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
51 </outputs>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
52 <tests>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
53 <test>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
54 <param name="db_opts_selector" value="file" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
55 <param name="subject" value="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
56 <param name="window" value="12" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
57 <param name="locut" value="2.2" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
58 <param name="hicut" value="2.5" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
59 <param name="outformat" value="fasta" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
60 <output name="outfile" file="segmasker_four_human.fasta" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
61 </test>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
62 <test>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
63 <param name="db_opts_selector" value="file" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
64 <param name="subject" value="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
65 <param name="window" value="12" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
66 <param name="locut" value="2.2" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
67 <param name="hicut" value="2.5" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
68 <param name="outformat" value="maskinfo_asn1_bin" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
69 <output name="outfile" file="segmasker_four_human.maskinfo-asn1-binary" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
70 </test>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
71 <test>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
72 <param name="db_opts_selector" value="file" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
73 <param name="subject" value="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
74 <param name="window" value="12" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
75 <param name="locut" value="2.2" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
76 <param name="hicut" value="2.5" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
77 <param name="outformat" value="maskinfo_asn1_text" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
78 <output name="outfile" file="segmasker_four_human.maskinfo-asn1" />
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
79 </test>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
80 </tests>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
81 <help>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
82 **What it does**
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
83
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
84 This tool identifies and masks out low complexity regions of a protein database (or proteins in FASTA format) by using the SEG_ algorithm.
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
85
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
86 If you select *maskinfo ASN.1* (binary or text) as output format, the output file can be used as masking data for NCBI BLAST+ makeblastdb tool.
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
87
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
88 More information about segmasker can be found in the `BLAST Command Line Applications User Manual`_.
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
89
12
d8f2c1f560ec Uploaded v0.1.08, can search multiple local databases, fixes a pipe problem in blastdbcmd, and minor internal changes.
peterjc
parents: 6
diff changeset
90 .. _BLAST Command Line Applications User Manual: https://www.ncbi.nlm.nih.gov/books/NBK279690/
31
13aa389f4eeb planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 16ef84e19ea373838bbfb921b9ef2cd4b02b8788-dirty
peterjc
parents: 21
diff changeset
91 .. _SEG: https://www.ncbi.nlm.nih.gov/pubmed/8743706
0
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
92
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
93 **References**
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
94
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
95 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
96 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
97
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
98 @REFERENCES@
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
99 </help>
432ea9614cc9 Uploaded v0.1.02 preview 1, using tool_data_table_conf.xml for loc files, etc
peterjc
parents:
diff changeset
100 <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
101 </tool>