annotate adjacent_features.xml @ 2:e2531f4dcdde draft default tip

planemo upload commit f33bdf952d796c5d7a240b132af3c4cbd102decc
author cpt
date Fri, 05 Jan 2024 05:51:24 +0000
parents e29c36ee61e0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
1 <tool id="edu.tamu.cpt2.gbk.adjacent_features" name="Find adjacent Genbank features" version="RC4">
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
2 <description>Searches a Genbank file for a given FASTA sequence, then outputs a file with adjacent upstream features, and another with adjacent downstream features.</description>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
3 <macros>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
4 <import>macros.xml</import>
2
e2531f4dcdde planemo upload commit f33bdf952d796c5d7a240b132af3c4cbd102decc
cpt
parents: 1
diff changeset
5
1
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
6 </macros>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
7 <expand macro="requirements"/>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
8 <command detect_errors="aggressive"><![CDATA[
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
9 python '$__tool_directory__/adjacent_features.py'
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
10 #set repeat_var_1 = '" "'.join([ str('$var') for '$var' in '$gbkIn' ])
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
11 #set repeat_var_2 = '" "'.join([ str('$var') for '$var' in '$fastaIn' ])
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
12 -genbankFiles "$repeat_var_1"
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
13 -fastaFiles "$repeat_var_2"
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
14 -tTable '$tTable'
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
15 -fTable '$fTable'
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
16 -upOut '$upstreamOut'
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
17 -downOut '$downstreamOut'
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
18 '$translate'
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
19 '$forceID'
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
20 '$mode'
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
21 --forward '$ahead'
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
22 --behind '$back'
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
23 ]]></command>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
24 <inputs>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
25 <param label="Genbank file" name="gbkIn" type="data" format="genbank" multiple="True"/>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
26 <param label="Fasta file" name="fastaIn" type="data" format="fasta" multiple="True"/>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
27 <param label="Translation table to use on Fasta input:" name="fTable" type="select">
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
28 <option value="0" selected="true">[0] Do not translate/ Fasta already translated</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
29 <option value="1">[1] The Standard Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
30 <option value="2">[2] The Vertebrate Mitochondrial Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
31 <option value="3">[3] The Yeast Mitochondrial Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
32 <option value="4">[4] The Mold, Protozoan, and Coelenterate Mitochondrial Code and the Mycoplasma/Spiroplasma Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
33 <option value="5">[5] The Invertebrate Mitochondrial Code </option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
34 <option value="6">[6] The Ciliate, Dasycladacean and Hexamita Nuclear Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
35 <option value="9">[9] The Echinoderm and Flatworm Mitochondrial Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
36 <option value="10">[10] The Euplotid Nuclear Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
37 <option value="11">[11] The Bacterial, Archaeal and Plant Plastid Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
38 <option value="12">[12] The Alternative Yeast Nuclear Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
39 <option value="13">[13] The Ascidian Mitochondrial Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
40 <option value="14">[14] The Alternative Flatworm Mitochondrial Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
41 <option value="15">[15] Blepharisma Nuclear Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
42 <option value="16">[16] Chlorophycean Mitochondrial Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
43 <option value="21">[21] Trematode Mitochondrial Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
44 <option value="22">[22] Scenedesmus Obliquus Mitochondrial Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
45 <option value="23">[23] Thraustochytrium Mitochondrial Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
46 <option value="24">[24] Pterobranchia Mitochondrial Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
47 <option value="25">[25] Candidate Division SR1 and Gracilibacteria Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
48 </param>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
49 <param label="Translation table to use on Genbank features:" name="tTable" type="select">
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
50 <option value="0">[0] Do not translate (Use nucleotide sequence of features)</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
51 <option value="1">[1] The Standard Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
52 <option value="2">[2] The Vertebrate Mitochondrial Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
53 <option value="3">[3] The Yeast Mitochondrial Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
54 <option value="4">[4] The Mold, Protozoan, and Coelenterate Mitochondrial Code and the Mycoplasma/Spiroplasma Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
55 <option value="5">[5] The Invertebrate Mitochondrial Code </option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
56 <option value="6">[6] The Ciliate, Dasycladacean and Hexamita Nuclear Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
57 <option value="9">[9] The Echinoderm and Flatworm Mitochondrial Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
58 <option value="10">[10] The Euplotid Nuclear Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
59 <option value="11" selected="true">[11] The Bacterial, Archaeal and Plant Plastid Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
60 <option value="12">[12] The Alternative Yeast Nuclear Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
61 <option value="13">[13] The Ascidian Mitochondrial Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
62 <option value="14">[14] The Alternative Flatworm Mitochondrial Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
63 <option value="15">[15] Blepharisma Nuclear Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
64 <option value="16">[16] Chlorophycean Mitochondrial Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
65 <option value="21">[21] Trematode Mitochondrial Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
66 <option value="22">[22] Scenedesmus Obliquus Mitochondrial Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
67 <option value="23">[23] Thraustochytrium Mitochondrial Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
68 <option value="24">[24] Pterobranchia Mitochondrial Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
69 <option value="25">[25] Candidate Division SR1 and Gracilibacteria Code</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
70 </param>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
71 <param label="Number of features upstream to return" name="ahead" type="integer" value="1"/>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
72 <param label="Number of features downstream to return" name="back" type="integer" value="1"/>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
73 <param label="Translate output to protein sequence" name="translate" type="boolean" truevalue="--outProt" falsevalue=""/>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
74 <param label="Genbank Protein's ID must also match Fasta Sequence's ID " name="forceID" type="boolean" truevalue="--forceSeqID" falsevalue="" checked="true"/>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
75 <param name="mode" type="select" label="Mode">
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
76 <option value="--genesOnly">Search only Gene-type features</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
77 <option value="--cdsOnly">Search only CDS-type features</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
78 <option value="">Search all features (Will most likely cause duplicate results, as this will include sub-features)</option>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
79 </param>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
80 </inputs>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
81 <outputs>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
82 <data name="upstreamOut" format="fasta" label="upOut"/>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
83 <data name="downstreamOut" format="fasta" label="downOut"/>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
84 </outputs>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
85 <help><![CDATA[
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
86 Currently Experimental: Uploaded for review purposes
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
87
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
88 **What it does**
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
89
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
90 For a given Fasta file, this tool searches through the features of a Genbank file for one that matches the sequence in the Fasta. If found, it will then output a specified number of features upstream from the hit and a specified number of features downstream as a multifasta file.
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
91
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
92 The drop down menus provide a selection of translation tables for the Fasta and Genbank inputs. If "translate output to protein sequence"
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
93 is selected, the output will be translated using the table selected for the Genbank translation.
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
94
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
95 It is currently recommended to select either the Gene only or CDS only options for mode, as searching all features will include sub-features of neighbors (ie, selecting 2 for upstream will give you the neighboring gene and then its CDS sub feature, rather than 2 proper neighbors) as well as the sub-features of the search hit itself.
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
96
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
97
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
98 ]]></help>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
99 <citations>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
100 <citation type="doi">10.1371/journal.pcbi.1008214</citation>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
101 <citation type="bibtex">
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
102 @unpublished{galaxyTools,
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
103 author = {A. Criscione},
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
104 title = {CPT Galaxy Tools},
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
105 year = {2019-2021},
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
106 note = {https://github.com/tamu-cpt/galaxy-tools/}
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
107 }
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
108 </citation>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
109 </citations>
e29c36ee61e0 planemo upload commit 94b0cd1fff0826c6db3e7dc0c91c0c5a8be8bb0c
cpt
parents:
diff changeset
110 </tool>