annotate cmbuild.xml @ 2:fac157e22e1b draft

Uploaded

<tool id="infernal_cmbuild" name="Build covariance models" version="1.1.0.1">
    <description>from sequence alignments (cmbuild)</description>
    <parallelism method="multi" split_inputs="alignment_infile" split_mode="to_size" split_size="10" shared_inputs="" merge_outputs="cmfile_outfile"></parallelism>
    <requirements>
        <requirement type="package">infernal</requirement>
        <requirement type="package" version="1.1">infernal</requirement>
        <requirement type="package" version="8.22">gnu_coreutils</requirement>
    </requirements>
    <command>
<![CDATA[
        cmbuild
            #if $is_summery_output:
                -o $summary_outfile
            #end if

            ## to many outputs, is that one really needed?
            ##-O $annotated_source_alignment_outfile

            $model_construction_opts.model_construction_opts_selector
            #if $model_construction_opts.model_construction_opts_selector == '--fast':
                --symfrac $model_construction_opts.symfrac
            #end if

            $noss

            $relative_weights_opts.relative_weights_opts_selector
            #if $relative_weights_opts.relative_weights_opts_selector == '--wblosum':
                --wid $relative_weights_opts.wid
            #end if

            $effective_opts.effective_opts_selector
            #if str($effective_opts.effective_opts_selector) == '--eent':
                --ere $effective_opts.ere
                --eminseq $effective_opts.eminseq
                --ehmmre $effective_opts.ehmmre
                --eset $effective_opts.eset
            #end if

            #if str($refining_opts.refining_opts_selector) == '--refine':
                #if $refining_opts.refine_output:
                    --refine $refined_multiple_alignment_output
                #else:
                    --refine /dev/null
                #end if

                $l
                $refining_opts.gibbs_opts.gibbs_opts_selector

                #if str($refining_opts.gibbs_opts.gibbs_opts_selector) == '--gibbs':
                    $refining_opts.gibbs_opts.random_seed
                #end if

                $notrunc
                $cyk
            #end if

            $cmfile_outfile
            $alignment_infile

]]>
    </command>
        <inputs>
            <!-- Stockholm or SELEX
            SELEX is defined in EMBOSS datatypes
            -->
            <param name="alignment_infile" type="data" format="stockholm,selex" label="Sequence database"/>

            <conditional name="model_construction_opts">
                <param name="model_construction_opts_selector" type="select" label="These options control how consensus columns are defined in an alignment" help="">
                    <option value="--fast" selected="true">automatic (--fast)</option>
                    <option value="--hand">user defined (--hand)</option>
                </param>
                <when value="--fast">
                    <param name="symfrac" type="float" value="0.5" size="5"
                        label="Define the residue fraction threshold necessary to define a consensus (--symfrac)" help=""/>
                </when>
                <when value="--hand"/>
            </conditional>

            <param name="noss" truevalue="--noss" falsevalue="" checked="False" type="boolean"
                label="Ignore the secondary structure annotation, if any, in your multiple alignment file (--noss)" help=""/>

            <conditional name="relative_weights_opts">
                <param name="relative_weights_opts_selector" type="select" label="Options controlling relative weights" help="">
                    <option value="--wpb" selected="true">Henikoff (--wgb)</option>
                    <option value="--wgsc">Gerstein/Sonnhammer/Chothia (--wgsc)</option>
                    <option value="--wnone">no sequence weighting (--wnone)</option>
                    <option value="--wgiven">Sequence weight from given in input file (--wgiven)</option>
                    <option value="--wblosum">BLOSUM filtering algorithm (--wblosum)</option>
                </param>
                <when value="--wpb"/>
                <when value="--wgsc"/>
                <when value="--wnone"/>
                <when value="--wgiven"/>
                <when value="--wblosum">
                    <param name="wid" type="float" value="0.5" size="5"
                        label="Percent identity for clustering the alignment (--wid)" help=""/>
                </when>
            </conditional>


            <conditional name="effective_opts">
                <param name="effective_opts_selector" type="select" label="Options controlling effective sequence number" help="">
                    <option value="--eent" selected="true">entropy weighting strategy (--eent)</option>
                    <option value="--enone">Turn off the entropy weighting strategy (--enone)</option>
                </param>
                <when value="--enone"/>
                <when value="--eent">
                    <param name="ere" type="float" value="0.59" size="5"
                        label="Set the target mean match state relative entropy (--ere)" help=""/>

                    <param name="eminseq" type="integer" value="" size="5"
                        label="Define the minimum allowed effective sequence number (--eminseq)" help=""/>

                    <param name="ehmmre" type="float" value="" size="5"
                        label="Set the target HMM mean match state relative entropy (--ehmmre)" help=""/>

                    <param name="eset" type="integer" value="" size="5"
                        label="Set the effective sequence number for entropy weighting (--eset)" help=""/>
                </when>
            </conditional>


            <conditional name="refining_opts">
                <param name="refining_opts_selector" type="select" label="Options for refining the input alignment" help="">
                    <option value="" selected="true">No refinement</option>
                    <option value="--refine">refine the input alignment</option>
                </param>
                <when value=""/>
                <when value="--refine">

                    <conditional name="gibbs_opts">
                        <param name="gibbs_opts_selector" type="select" label="refinement mode" help="">
                            <option value="" selected="true">expectation-maximization (EM)</option>
                            <option value="--gibbs">Gibbs sampling</option>
                        </param>
                        <when value=""/>
                        <when value="--gibbs">
                            <param name="random_seed" type="integer" value="0" label="Randam Seed" help="" />
                        </when>
                    </conditional>

                    <param name="l" truevalue="-l" falsevalue="" checked="False" type="boolean"
                        label="Turn on the local alignment algorithm" help="... which allows the alignment to span two or more subsequences if necessary"/>

                    <param name="notrunc" truevalue="--notrunc" falsevalue="" checked="False" type="boolean"
                        label="Turn off the truncated alignment algorithm" help=""/>

                    <param name="cyk" type="select" label="Options for refining the input alignment" help="">
                        <option value="" selected="true">optimal accuracy algorithm</option>
                        <option value="--cyk">align with the CYK algorithm</option>
                    </param>

                    <param name="refine_output" truevalue="" falsevalue="" checked="False" type="boolean"
                        label="Output the refined alignment file as it is used to build the covariance model" help=""/>

                </when>
            </conditional>


            <param name="is_summery_output" truevalue="" falsevalue="" checked="False" type="boolean"
                label="Output a summery file?" help=""/>

        </inputs>
    <outputs>

        <data format="text" name="summary_outfile" label="cmbuild summary on ${on_string}">
            <filter>is_summery_output is True</filter>
        </data>
        <!--<data format="stockholm" name="annotated_source_alignment_outfile" label="Annotated alignment from ${on_string}"/>-->
        <data format="cm" name="cmfile_outfile" label="Covariance models from ${on_string}"/>

        <data format="stockholm" name="refined_multiple_alignment_output" label="refined alignment file of ${on_string}">
            <filter>
                ((
                refining_opts['refining_opts_selector'] == "--refine" and
                refining_opts['refine_output'] is True
                ))
            </filter>
        </data>

    </outputs>
    <help>
<![CDATA[


**What it does**

For each multiple sequence alignment build a covariance model.
The alignment file must be in Stockholm or SELEX format, and must contain consensus secondary structure annotation.
cmbuild uses the consensus structure to determine the architecture of the CM.

In addition to writing CM(s) to CMFILE_OUT, cmbuild also outputs a single line for each model created to stdout. Each
line has the following fields: ”aln”: the index of the alignment used to build the CM; ”idx”: the index of the CM in the
CMFILE_OUT; ”name”: the name of the CM; ”nseq”: the number of sequences in the alignment used to build the CM;
”eff nseq”: the effective number of sequences used to build the model; ”alen”: the length of the alignment used to build
the CM; ”clen”: the number of columns from the alignment defined as consensus (match) columns; ”bps”: the number
of basepairs in the CM; ”bifs”: the number of bifurcations in the CM; ”rel entropy: CM”: the total relative entropy of the
model divided by the number of consensus columns; ”rel entropy: HMM”: the total relative entropy of the model ignoring
secondary structure divided by the number of consensus columns. ”description”: description of the model/alignment.


Options controlling model construction
--------------------------------------

These options control how consensus columns are defined in an alignment.

  * --fast Define consensus columns automatically as those that have a fraction >= symfrac of residues as opposed to gaps. (See below for the --symfrac option.) This is the default.
  * --hand Use reference coordinate annotation (#=GC RF line, in Stockholm) to determine which columns are consensus, and which are inserts. Any non-gap character indicates a consensus column. (For example, mark consensus columns with ”x”, and insert columns with ”.”.)
  * --symfrac Define the residue fraction threshold necessary to define a consensus column when not using --hand. The default is 0.5. The symbol fraction in each column is calculated after taking relative sequence weighting into account. Setting this to 0.0 means that every alignment column will be assigned as consensus, which may be useful in some cases. Setting it to 1.0 means that only columns that include 0 gaps will be assigned as consensus.
  * --noss Ignore the secondary structure annotation, if any, in MSA-Infile and build a CM with zero basepairs. This model will be similar to a profile HMM and the cmsearch and cmscan programs will use HMM algorithms which are faster than CM ones for this model. Additionally, a zero basepair model need not be calibrated with cmcalibrate prior to running cmsearch with it. The --noss option must be used if there is no secondary structure annotation in MSA-Infile.


Options controlling relative weights
------------------------------------

cmbuild uses an ad hoc sequence weighting algorithm to downweight closely related sequences and upweight distantly
related ones. This has the effect of making models less biased by uneven phylogenetic representation. For example,
two identical sequences would typically each receive half the weight that one sequence would. These options control
which algorithm gets used.

  * --wpb Use the Henikoff position-based sequence weighting scheme [Henikoff and Henikoff, J. Mol. Biol. 243:574, 1994]. This is the default.
  * --wgsc Use the Gerstein/Sonnhammer/Chothia weighting algorithm [Gerstein et al, J. Mol. Biol. 235:1067, 1994].
  * --wnone Turn sequence weighting off; e.g. explicitly set all sequence weights to 1.0.
  * --wgiven Use sequence weights as given in annotation in the input alignment file. If no weights were given, assume they are all 1.0. The default is to determine new sequence weights by the Gerstein/Sonnhammer/Chothia algorithm, ignoring any annotated weights.
  * --wblosum Use the BLOSUM filtering algorithm to weight the sequences, instead of the default GSC weighting. Cluster the sequences at a given percentage identity (see --wid); assign each cluster a total weight of 1.0, distributed equally amongst the members of that cluster.
  * --wid Controls the behavior of the --wblosum weighting option by setting the percent identity for clustering the alignment.


Options controlling effective sequence number
---------------------------------------------

After relative weights are determined, they are normalized to sum to a total effective sequence number, eff nseq. This
number may be the actual number of sequences in the alignment, but it is almost always smaller than that. The default
entropy weighting method (--eent) reduces the effective sequence number to reduce the information content (relative
entropy, or average expected score on true homologs) per consensus position. The target relative entropy is controlled
by a two-parameter function, where the two parameters are settable with --ere and --esigma.

  * --eent Use the entropy weighting strategy to determine the effective sequence number that gives a target mean match state relative entropy. This option is the default, and can be turned off with --enone. The default target mean match state relative entropy is 0.59 bits for models with at least 1 basepair and 0.38 bits for models with zero basepairs, but changed with --ere. The default of 0.59 or 0.38 bits is automatically changed if the total relative entropy of the model (summed match state relative entropy) is less than a cutoff, which is is 6.0 bits by default, but can be changed with the expert, undocumented --eX option. If you really want to play with that option, consult the source code.
  * --enone Turn off the entropy weighting strategy. The effective sequence number is just the number of sequences in the alignment.
  * --ere Set the target mean match state relative entropy. By default the target relative entropy per match position is 0.59 bits for models with at least 1 basepair and 0.38 for models with zero basepairs.
  * --eminseq Define the minimum allowed effective sequence number.
  * --ehmmre Set the target HMM mean match state relative entropy. Entropy for basepairing match states is calculated using marginalized basepair emission probabilities.
  * --eset Set the effective sequence number for entropy weighting.



Options for refining the input alignment
----------------------------------------

  * --refine Attempt to refine the alignment before building the CM using expectation-maximization (EM). A CM is first built from the initial alignment as usual. Then, the sequences in the alignment are realigned optimally (with the HMM banded CYK algorithm, optimal means optimal given the bands) to the CM, and a new CM is built from the resulting alignment. The sequences are then realigned to the new CM, and a new CM is built from that alignment. This is continued until convergence, specifically when the alignments for two successive iterations are not significantly different (the summed bit scores of all the sequences in the alignment changes less than 1% between two successive iterations).
  * -l Turn on the local alignment algorithm, which allows 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. The default is to globally align the query model to the target sequences.
  * --gibbs Modifies the behavior of --refine so Gibbs sampling is used instead of EM. The difference is that during the alignment stage the alignment is not necessarily optimal, instead an alignment (parsetree) for each sequences is sampled from the posterior distribution of alignments as determined by the Inside algorithm. Due to this sampling step --gibbs is non- deterministic, so different runs with the same alignment may yield different results. This is not true when --refine is used without the --gibbs option, in which case the final alignment and CM will always be the same. When --gibbs is enabled, the --seed "number" option can be used to seed the random number generator predictably, making the results reproducible. The goal of the --gibbs option is to help expert RNA alignment curators refine structural alignments by allowing them to observe alternative high scoring alignments.
  * --seed Seed the random number generator with an integer >= 0. This option can only be used in combination with --gibbs. If the given number is nonzero, stochastic sampling of alignments will be reproducible; the same command will give the same results. If the given number is 0, the random number generator is seeded arbitrarily, and stochastic samplings may vary from run to run of the same command. The default seed is 0.
  * --cyk With --refine, align with the CYK algorithm. By default the optimal accuracy algorithm is used. There is more information on this in the cmalign manual page.
  * --notrunc With --refine, turn off the truncated alignment algorithm. There is more information on this in the cmalign manual page.


For further questions please refere to the Infernal Userguide_.

.. _Userguide: http://selab.janelia.org/software/infernal/Userguide.pdf


How do I cite Infernal?
-----------------------

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).

**Galaxy Wrapper Author**::

    *  Bjoern Gruening, University of Freiburg

]]>
    </help>
</tool>