annotate glimmer3_wrapper.xml @ 0:9c8ffce71f7c draft default tip

Uploaded
author crs4
date Mon, 09 Sep 2013 12:16:17 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
1 <tool id="glimmer3_wrapper" name="Glimmer3" version="0.2">
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
2 <description></description>
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
3 <requirements>
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
4 <requirement type="package" version="3.02">glimmer</requirement>
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
5 </requirements>
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
6 <command interpreter="python">
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
7 glimmer3_wrapper.py --glSequence $glSequence --glIcm $glIcm
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
8 #if $glStartCodons
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
9 --glStartCodons="$glStartCodons"
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
10 #end if
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
11 #if $glRbsPwm
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
12 --glRbsPwm=$glRbsPwm
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
13 #end if
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
14 #if str($glGcPercent)
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
15 --glGcPercent=$glGcPercent
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
16 #end if
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
17 #if $glEntropy.glEntropy_select == 'default'
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
18 --glEntropy='#'
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
19 #else if $glEntropy.glEntropy_select == 'fromfile'
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
20 --glEntropy=${glEntropy.glEntropyFile}
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
21 #end if
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
22 #if $glFirstCodon
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
23 --glFirstCodon
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
24 #end if
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
25 #if str($glGeneLen)
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
26 --glGeneLen=$glGeneLen
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
27 #end if
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
28 #if $glLinear
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
29 --glLinear
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
30 #end if
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
31 #if $glOrfCoords
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
32 --glOrfCoords=$glOrfCoords
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
33 #end if
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
34 #if $glSeparateGenes
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
35 --glSeparateGenes
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
36 #end if
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
37 #if str($glMaxOverlap)
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
38 --glMaxOverlap=$glMaxOverlap
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
39 #end if
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
40 #if $glStartProbs
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
41 --glStartProbs="$glStartProbs"
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
42 #end if
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
43 #if str($glIgnoreScoreLen)
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
44 --glIgnoreScoreLen=$glIgnoreScoreLen
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
45 #end if
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
46 #if $glNoIndep
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
47 --glNoIndep
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
48 #end if
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
49 #if str($glThreshold)
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
50 --glThreshold=$glThreshold
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
51 #end if
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
52 #if $glExtend
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
53 --glExtend
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
54 #end if
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
55 #if str($glTransTable)
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
56 --glTransTable=$glTransTable
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
57 #end if
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
58 #if $glStopCodons
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
59 --glStopCodons="$glStopCodons"
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
60 #end if
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
61 --glDetail $glDetail --glPredict $glPredict --logfile $logfile
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
62 </command>
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
63
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
64 <inputs>
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
65 <param name="glSequence" type="data" format="fasta" label="DNA sequences to be analyzed" help="FASTA format" />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
66
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
67 <param name="glIcm" type="data" format="glimmer_icm" label="ICM model produced by Build-ICM" />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
68
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
69 <param name="glStartCodons" type="text" value="" optional="true" label="Specify allowable start codons as a comma-separated list (-A, --start_codons)" help="Sample format: 'atg,gtg' . The default start codons are atg, gtg and ttg. Use the 'GC percentage' option to specify the relative proportions of use, elsethe the proportions will be equal." />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
70
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
71 <param name="glRbsPwm" type="data" format="glimmer_pwm" optional="true" label="Position weight matrix representing the ribosome binding site for genes (-b, --rbs_pwm)" help="Used to improve the accuracy of start site predictions." />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
72
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
73 <param name="glGcPercent" type="float" value="" optional="true" label="GC percentage of the independent model, e.g. 45.2 (-C, --gc_percent)" help="If this option is not specified, the GC percentage will be counted from the input file." />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
74
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
75 <conditional name="glEntropy">
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
76 <param name="glEntropy_select" type="select" label="Use entropy profiles (-E, --entropy)">
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
77 <option value="no">No</option>
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
78 <option value="default">Use default entropy profiles, constructed from a wide range of species (-E #)</option>
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
79 <option value="fromfile">Use entropy profiles from history</option>
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
80 </param>
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
81 <when value="no" />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
82 <when value="default" />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
83 <when value="fromfile">
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
84 <param name="glEntropyFile" type="data" format="glimmer_entropy_profiles" label="Entropy profiles" help="As generated by Glimmer entropy-profile" />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
85 </when>
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
86 </conditional>
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
87
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
88 <param name="glFirstCodon" type="boolean" checked="false" label="Use the first possible codon in an ORF as the start codon for initial scoring purposes (-f, --first_codon)" help="Otherwise, the highest-scoring codon will be used. This only affects the start positions in the .detail file. The final start predictions in the .predict file are always based on the scoring functions." />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
89
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
90 <param name="glGeneLen" type="integer" value="" optional="true" label="Minimum gene length in number of nucleotides (-g, --gene_len)" help="It does not include the bases in the stop codon." />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
91
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
92 <param name="glLinear" type="boolean" checked="false" label="Assuming a linear genome (-l, --linear)" help="No 'wrap-around' genes with part at the beginning of the sequence and the rest at the end of the sequence." />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
93
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
94 <param name="glOrfCoords" type="data" format="glimmer_coords" optional="true" label="Coordinates file specifying a list of ORFs that should be scored separately, with no overlap rules (-L, --orf_coords)" help="The output with this option goes both to the .predict file and to the .detail file." />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
95
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
96 <param name="glSeparateGenes" type="boolean" checked="false" label="Separate genes (-M, --separate_genes)" help="" />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
97
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
98 <param name="glMaxOverlap" type="integer" value="" optional="true" label="Maximum overlap length (-o, --max_olap)" help="Overlaps of this many or fewer bases between genes are not regarded as overlaps." />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
99
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
100 <param name="glStartProbs" type="text" value="" optional="true" label="Probability of different start codons (-P, --start_probs)" help="If no --codon_list option is given, then there should be 3 values: for atg, gtg and ttg, in that order. Sample format: -P 0.6,0.35,0.05. If --codon_list is specified without --start_probs, then each start codon is equally likely (which is very unusual)." />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
101
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
102 <param name="glIgnoreScoreLen" type="integer" value="" optional="true" label="Consider any gene n or more bases long as a potential gene, regardless of its in-frame score (-q, --ignore_score_len)" help="Without this option, this value is calculated automatically to be the length such that the expected number of ORFs this long or longer in a random sequence of a million bases is one." />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
103
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
104 <param name="glNoIndep" type="boolean" checked="false" label="Do not use the independent probability score column (-r, --no_indep)" help="Using this option will produce more short gene predictions." />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
105
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
106 <param name="glThreshold" type="integer" value="" optional="true" label="Threshold score for consideration as a gene (-t, --threshold)" help="If the in-frame score ≥ n , then the region is given a number and considered a potential gene. Note this is the integer score in the column labelled 'InFrm' in the .detail file, not the decimal score in the column labelled 'Raw'." />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
107
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
108 <param name="glExtend" type="boolean" checked="false" label="Also score ORFs that extend off the end of the sequence(s) (-X, --extend)" help="This option presumes that the sequence(s) is linear and not circular. Reported positions off the end of the sequence are the nearest positions in the correct reading frame. Note that this ignores any partial codons at the ends of a sequence. Suppose, for example, that a sequence is 998bp long and an ORF in reading frame +1 starts at position 601 and extends off the end of the sequence. Then the end of that gene/ORF will be reported at position 999, as if the stop codon were in positions 997 ... 999. This is true even if the last two characters of the sequence are, say, cc and cannot possibly be part of a stop codon." />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
109
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
110 <param name="glTransTable" type="integer" value="" optional="true" label="Use GenBank translation table number n to specify stop codons (-z, --trans_table)" help="" />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
111
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
112 <param name="glStopCodons" type="text" value="" optional="true" label="Specify allowable stop codons as a comma-separated list (-Z, --stop_codons)" help="Sample format: 'tag,tga,taa'. The default stop codons are tag, tga and taa." />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
113 </inputs>
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
114
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
115 <outputs>
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
116 <data name="logfile" format="txt" label="${tool.name} on ${on_string}: log" />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
117 <data name="glDetail" format="txt" label="${tool.name} on ${on_string}: detail" />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
118 <data name="glPredict" format="txt" label="${tool.name} on ${on_string}: predict" />
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
119 </outputs>
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
120
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
121 <tests>
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
122
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
123 </tests>
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
124 <help>
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
125 **What it does**
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
126
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
127 Read DNA sequences and predict genes in them using an Interpolated Context Model (ICM). Output details go to file *detail* and predictions go to file *predict*.
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
128
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
129 **License and citation**
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
130
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
131 This Galaxy tool is Copyright © 2013 `CRS4 Srl.`_ and is released under the `MIT license`_.
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
132
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
133 .. _CRS4 Srl.: http://www.crs4.it/
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
134 .. _MIT license: http://opensource.org/licenses/MIT
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
135
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
136 If you use this tool in Galaxy, please cite |Cuccuru2013|_.
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
137
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
138 .. |Cuccuru2013| replace:: Cuccuru, G., Orsini, M., Pinna, A., Sbardellati, A., Soranzo, N., Travaglione, A., Uva, P., Zanetti, G., Fotia, G. (2013) Orione, a web-based framework for NGS analysis in microbiology. *Submitted*
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
139 .. _Cuccuru2013: http://orione.crs4.it/
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
140
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
141 This tool uses `Glimmer`_, which is licensed separately. Please cite |Delcher2007|_.
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
142
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
143 .. _Glimmer: http://ccb.jhu.edu/software/glimmer/index.shtml
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
144 .. |Delcher2007| replace:: Delcher, A. L., Bratke, K. A., Powers, E. C., Salzberg, S. L. (2007) Identifying bacterial genes and endosymbiont DNA with Glimmer. *Bioinformatics* 23(6), 673-679
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
145 .. _Delcher2007: http://bioinformatics.oxfordjournals.org/content/23/6/673
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
146 </help>
9c8ffce71f7c Uploaded
crs4
parents:
diff changeset
147 </tool>