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

Uploaded
author crs4
date Mon, 09 Sep 2013 12:16:17 -0400
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/glimmer3_wrapper.xml	Mon Sep 09 12:16:17 2013 -0400
@@ -0,0 +1,147 @@
+<tool id="glimmer3_wrapper" name="Glimmer3" version="0.2">
+  <description></description>
+  <requirements>
+    <requirement type="package" version="3.02">glimmer</requirement>
+  </requirements>
+  <command interpreter="python">
+    glimmer3_wrapper.py --glSequence $glSequence --glIcm $glIcm
+    #if $glStartCodons
+      --glStartCodons="$glStartCodons"
+    #end if
+    #if $glRbsPwm
+      --glRbsPwm=$glRbsPwm
+    #end if
+    #if str($glGcPercent)
+      --glGcPercent=$glGcPercent
+    #end if
+    #if $glEntropy.glEntropy_select == 'default'
+      --glEntropy='#'
+    #else if $glEntropy.glEntropy_select == 'fromfile'
+      --glEntropy=${glEntropy.glEntropyFile}
+    #end if
+    #if $glFirstCodon
+      --glFirstCodon
+    #end if
+    #if str($glGeneLen)
+      --glGeneLen=$glGeneLen
+    #end if
+    #if $glLinear
+      --glLinear
+    #end if
+    #if $glOrfCoords
+      --glOrfCoords=$glOrfCoords
+    #end if
+    #if $glSeparateGenes
+      --glSeparateGenes
+    #end if
+    #if str($glMaxOverlap)
+      --glMaxOverlap=$glMaxOverlap
+    #end if
+    #if $glStartProbs
+      --glStartProbs="$glStartProbs"
+    #end if
+    #if str($glIgnoreScoreLen)
+      --glIgnoreScoreLen=$glIgnoreScoreLen
+    #end if
+    #if $glNoIndep
+      --glNoIndep
+    #end if
+    #if str($glThreshold)
+      --glThreshold=$glThreshold
+    #end if
+    #if $glExtend
+      --glExtend
+    #end if
+    #if str($glTransTable)
+      --glTransTable=$glTransTable
+    #end if
+    #if $glStopCodons
+      --glStopCodons="$glStopCodons"
+    #end if
+    --glDetail $glDetail --glPredict $glPredict --logfile $logfile
+  </command>
+
+  <inputs>
+    <param name="glSequence" type="data" format="fasta" label="DNA sequences to be analyzed" help="FASTA format" />
+
+    <param name="glIcm" type="data" format="glimmer_icm" label="ICM model produced by Build-ICM" />
+
+    <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." />
+
+    <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." />
+
+    <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." />
+
+    <conditional name="glEntropy">
+      <param name="glEntropy_select" type="select" label="Use entropy profiles (-E, --entropy)">
+        <option value="no">No</option>
+        <option value="default">Use default entropy profiles, constructed from a wide range of species (-E #)</option>
+        <option value="fromfile">Use entropy profiles from history</option>
+      </param>
+      <when value="no" />
+      <when value="default" />
+      <when value="fromfile">
+        <param name="glEntropyFile" type="data" format="glimmer_entropy_profiles" label="Entropy profiles" help="As generated by Glimmer entropy-profile" />
+      </when>
+    </conditional>
+
+    <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." />
+
+    <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." />
+
+    <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." />
+
+    <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." />
+
+    <param name="glSeparateGenes" type="boolean" checked="false" label="Separate genes (-M, --separate_genes)" help="" />
+
+    <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." />
+
+    <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)." />
+
+    <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." />
+
+    <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." />
+
+    <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'." />
+
+    <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." />
+
+    <param name="glTransTable" type="integer" value="" optional="true" label="Use GenBank translation table number n to specify stop codons (-z, --trans_table)" help="" />
+
+    <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." />
+  </inputs>
+
+  <outputs>
+    <data name="logfile" format="txt" label="${tool.name} on ${on_string}: log" />
+    <data name="glDetail" format="txt" label="${tool.name} on ${on_string}: detail" />
+    <data name="glPredict" format="txt" label="${tool.name} on ${on_string}: predict" />
+  </outputs>
+
+  <tests>
+
+  </tests>
+  <help>
+**What it does**
+
+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*.
+
+**License and citation**
+
+This Galaxy tool is Copyright © 2013 `CRS4 Srl.`_ and is released under the `MIT license`_.
+
+.. _CRS4 Srl.: http://www.crs4.it/
+.. _MIT license: http://opensource.org/licenses/MIT
+
+If you use this tool in Galaxy, please cite |Cuccuru2013|_.
+
+.. |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*
+.. _Cuccuru2013: http://orione.crs4.it/
+
+This tool uses `Glimmer`_, which is licensed separately. Please cite |Delcher2007|_.
+
+.. _Glimmer: http://ccb.jhu.edu/software/glimmer/index.shtml
+.. |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
+.. _Delcher2007: http://bioinformatics.oxfordjournals.org/content/23/6/673
+  </help>
+</tool>