diff cmsearch.xml @ 3:2c2c5e5e495b draft

planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 9eeedfaf35c069d75014c5fb2e42046106bf813c-dirty

--- a/cmsearch.xml	Fri Feb 13 03:10:51 2015 -0500
+++ b/cmsearch.xml	Fri Mar 04 07:24:53 2016 -0500
@@ -135,7 +135,7 @@
                 </param>
                 <when value=""/>
                 <when value="--incE">
-                    <param name="incE" type="float" value="0.01" size="5" label="Use E-value" help="of &lt;= X as the hit inclusion threshold.">
+                    <param name="incE" type="float" value="0.01" label="Use E-value" help="of &lt;= X as the hit inclusion threshold.">
                         <sanitizer>
                             <valid initial="string.printable">
                                 <remove value="&apos;"/>
@@ -144,7 +144,7 @@
                     </param>
                 </when>
                 <when value="--incT">
-                    <param name="incT" type="integer" size="5" value="0" label="Use bit score" help="of >= X as the hit inclusion threshold.">
+                    <param name="incT" type="integer" value="0" label="Use bit score" help="of >= X as the hit inclusion threshold.">
                         <sanitizer>
                             <valid initial="string.printable">
                                 <remove value="&apos;"/>
@@ -165,7 +165,7 @@
                 </param>
                 <when value=""/>
                 <when value="-E">
-                    <param name="E" type="float" value="10.0" size="5" label="Use E-value" help="of &lt;= X as the hit reporting threshold. The default is 10.0, meaning that on average, about 10 false positives will be reported per query, so you can see the top of the noise and decide for yourself if it’s really noise.">
+                    <param name="E" type="float" value="10.0" label="Use E-value" help="of &lt;= X as the hit reporting threshold. The default is 10.0, meaning that on average, about 10 false positives will be reported per query, so you can see the top of the noise and decide for yourself if it’s really noise.">
                         <sanitizer>
                             <valid initial="string.printable">
                                 <remove value="&apos;"/>
@@ -174,7 +174,7 @@
                     </param>
                 </when>
                 <when value="-T">
-                    <param name="T" type="integer" size="5" value="0" label="Use bit score" help="of >= X as the hit reporting threshold.">
+                    <param name="T" type="integer" value="0" label="Use bit score" help="of >= X as the hit reporting threshold.">
                         <sanitizer>
                             <valid initial="string.printable">
                                 <remove value="&apos;"/>
@@ -202,57 +202,88 @@
 
 **What it does**
 
-Infernal is used to search sequence databases for homologs of structural RNA sequences, and to make
-sequence- and structure-based RNA sequence alignments. Infernal needs a profile from a structurally
-annotated multiple sequence alignment of an RNA family with a position-specific scoring system for substitutions,
-insertions, and deletions. Positions in the profile that are basepaired in the consensus secondary
-structure of the alignment are modeled as dependent on one another, allowing Infernal’s scoring system to
-consider the secondary structure, in addition to the primary sequence, of the family being modeled. Infernal
-profiles are probabilistic models called “covariance models”, a specialized type of stochastic context-free
-grammar (SCFG) (Lari and Young, 1990).
+cmsearch belongs to the INFERNAL software package that allows you to make consensus RNA secondary structure profiles, and use them to search nucleic acid sequence databases for homologous RNAs, or to create new structure-based multiple sequence alignments.
+You can use your model to search for new homologues of your RNA family. cmsearch is used to search one or more covariance models (CMs) against a sequence database. cmsearch searches both strands of each sequence in the target database, and returns alignments for high scoring hits.
+
+To build CMs from multiple alignments, see cmbuild (build covariance models).
 
-Compared to other alignment and database search tools based only on sequence comparison, Infernal
-aims to be significantly more accurate and more able to detect remote homologs because it models sequence
-and structure.
+
+**Input**
+
+The CM query file must have been calibrated for E-values with cmcalibrate. As a special exception, any models CM query files that have zero basepairs need not be calibrated. 
 
 
-Output format
--------------
+**Options**
+
+- *Turn on the glocal alignment algorithm*: global with respect to the query model and local with respect to the target database. By default, the local alignment algorithm is used which is local with respect to both the target sequence and the model. In local mode, the alignment to span two or more subsequences if necessary (e.g. if the structures of the query model and target sequence are only partially shared), allowing certain large insertions and deletions in the structure to be penalized differently than normal indels. Local mode performs better on empirical benchmarks and is significantly more sensitive for remote homology detection. Empirically, glocal searches return many fewer hits than local searches, so glocal may be desired for some applications. With *Turn on the glocal alignment algorithm*, all models must be calibrated, even those with zero basepairs.
+
+- *Only search the bottom (Crick) strand of target sequences*: Hits can occur on either the top (Watson) or bottom (Crick) strand of the target sequence. By default, both strands are searched.
+
+- *Only search the top (Watson) strand of target sequences*: Hits can occur on either the top (Watson) or bottom (Crick) strand of the target sequence. By default, both strands are searched.
+
+- *Use the CYK algorithm, not Inside, to determine the final score of all hits*: If selecting "yes", the CYK algorithm instead of the CM Inside algorithm (the SCFG analog of the HMM Forward algorithm) is used.
 
-(1) target name: The name of the target sequence or profile.
-(2) accession: The accession of the target sequence or profile, or ’-’ if none.
-(3) query name: The name of the query sequence or profile.
-(4) accession: The accession of the query sequence or profile, or ’-’ if none.
-(5) mdl (model): Which type of model was used to compute the final score. Either ’cm’ or ’hmm’. A CM is used to compute the final hit scores unless the model has zero basepairs or the --hmmonly option is used, in which case a HMM will be used.
-(6) mdl from (model coord): The start of the alignment of this hit with respect to the profile (CM or HMM), numbered 1..N for a profile of N consensus positions.
-(7) mdl to (model coord): The end of the alignment of this hit with respect to the profile (CM or HMM), numbered 1..N for a profile of N consensus positions.
-(8) seq from (ali coord): The start of the alignment of this hit with respect to the sequence, numbered 1..L for a sequence of L residues.
-(9) seq to (ali coord): The end of the alignment of this hit with respect to the sequence, numbered 1..L for a sequence of L residues.
-(10) strand: The strand on which the hit occurs on the sequence. ’+’ if the hit is on the top (Watson) strand, ’-’ if the hit is on the bottom (Crick) strand. If on the top strand, the “seq from” value will be less than or equal to the “seq to” value, else it will be greater than or equal to it.
-(11) trunc: Indicates if this is predicted to be a truncated CM hit or not. This will be “no” if it is a CM hit that is not predicted to be truncated by the end of the sequence, “5’ ” or “3’ ” if the hit is predicted to have one or more 5’ or 3’ residues missing due to a artificial truncation of the sequence, or “5’&3”’ if the hit is predicted to have one or more 5’ residues missing and one or more 3’ residues missing. If the hit is an HMM hit, this will always be ’-’.
-(12) pass: Indicates what “pass” of the pipeline the hit was detected on. This is probably only useful for testing and debugging. Non-truncated hits are found on the first pass, truncated hits are found on successive passes.
-(13) gc: Fraction of G and C nucleotides in the hit.
-(14) bias: The biased-composition correction: the bit score difference contributed by the null3 model for CM hits, or the null2 model for HMM hits. High bias scores may be a red flag for a false positive. It is difficult to correct for all possible ways in which a nonrandom but nonhomologous biological sequences can appear to be similar, such as short-period tandem repeats, so there are cases where the bias correction is not strong enough (creating false positives).
-(15) score: The score (in bits) for this target/query comparison. It includes the biased-composition cor-rection (the “null3” model for CM hits, or the “null2” model for HMM hits).
-(16) E-value: The expectation value (statistical significance) of the target. This is a per query E-value; i.e. calculated as the expected number of false positives achieving this comparison’s score for a single query against the search space Z. For cmsearch Z is defined as the total number of nucleotides in the target dataset multiplied by 2 because both strands are searched. For cmscan Z is the total number of nucleotides in the query sequence multiplied by 2 because both strands are searched and multiplied by the number of models in the target database. If you search with multiple queries and if you want to control the overall false positive rate of that search rather than the false positive rate per query, you will want to multiply this per-query E-value by how many queries you’re doing.
-(17) inc: Indicates whether or not this hit achieves the inclusion threshold: ’!’ if it does, ’?’ if it does not (and rather only achieves the reporting threshold). By default, the inclusion threshold is an E-value of 0.01 and the reporting threshold is an E-value of 10.0, but these can be changed with command line options as described in the manual pages.
-(18) description of target: The remainder of the line is the target’s description line, as free text.
+- *Use the CYK algorithm to align hits*: By default, the Durbin/Holmes optimal accuracy algo-
+rithm is used, which finds the alignment that maximizes the expected accuracy of all aligned
+residues.
+
+- *Turn off truncated hit detection*: Turns off truncated hit detection and will reduce the running time most significantly for target files that include many short sequences.
+
+- *Turn off all filters, and run non-banded Inside on every full-length target sequence*: This
+increases sensitivity somewhat, at an extremely large cost in speed.
+
+- *Turn off all HMM filter stages*: The CYK filter, using QDBs, will be run on every full-length target sequence and will enforce a P-value threshold of 0.0001. Each subsequence that survives CYK will be passed to Inside, which will also use QDBs (but a looser set). This increases sensitivity somewhat, at a very large cost in speed.
+
+-*Turn off the HMM SSV and Viterbi filter stages*:Sets remaining HMM filter
+thresholds to 0.02 by default. This may increase sensitivity, at a significant cost in speed.
+
+- *Inclusion thresholds*: *Use E-value* - Use an E-value as the hit inclusion threshold. The default is 0.01, meaning that on average, about 1 false positive would be expected in every 100 searches with different
+query sequences. *Use Bit Score* - Instead of using E-values for setting the inclusion threshold, instead use a bit score as the hit inclusion threshold. By default this option is unset.
 
 
-For further questions please refere to the Infernal Userguide_.
+**Output Options**
 
-.. _Userguide: http://selab.janelia.org/software/infernal/Userguide.pdf
+- *reporting thresholds*: Hits are ranked by statistical significance (E-value). By *default*, all hits with an E-value <= 10 are reported. The following options allow you to change the default *E-value* reporting thresholds, or to use *bit score* thresholds instead. 
+
+
+Output Example:
 
 
-How do I cite Infernal?
------------------------
+# cmsearch :: search CM(s) against a sequence database
+# INFERNAL 1.1.1 (July 2014)
+# Copyright (C) 2014 Howard Hughes Medical Institute.
+# Freely distributed under the GNU General Public License (GPLv3).
+# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+# query CM file:                         tRNA5.cm
+# target sequence database:              tutorial/mrum-genome.fa
+# number of worker threads:              8
+# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
 
-The recommended citation for using Infernal 1.1 is E. P. Nawrocki and S. R. Eddy, Infernal 1.1: 100-fold faster RNA homology searches , Bioinformatics 29:2933-2935 (2013).
+The second section is a list of ranked top hits (sorted by E-value, most significant hit first):
 
-**Galaxy Wrapper Author**::
+rank     E-value  score  bias  sequence      start     end   mdl trunc   gc  description
+----   --------- ------ -----  ----------- ------- -------   --- ----- ----  -----------
+(1) !   1.3e-18   71.5   0.0  NC_013790.1  362026  361955 -  cm    no 0.50  Methanobrevibacter ruminantium M1 
+(2) !   3.3e-18   70.2   0.0  NC_013790.1 2585265 2585193 -  cm    no 0.60  Methanobrevibacter ruminantium M1 
 
-    *  Bjoern Gruening, University of Freiburg
+
+
+For further questions please refere to the Infernal `Userguide <http://selab.janelia.org/software/infernal/Userguide.pdf>`_.
 
 ]]>
     </help>
+    <citations>
+        <citation type="doi">10.1093/bioinformatics/btt509</citation>
+        <citation type="bibtex">
+            @ARTICLE{bgruening_galaxytools,
+                Author = {Björn Grüning, Cameron Smith, Torsten Houwaart, Nicola Soranzo, Eric Rasche},
+                keywords = {bioinformatics, ngs, galaxy, cheminformatics, rna},
+                title = {{Galaxy Tools - A collection of bioinformatics and cheminformatics tools for the Galaxy environment}},
+                url = {https://github.com/bgruening/galaxytools}
+            }
+        </citation>
+    </citations>
+   
+    
 </tool>