annotate hyphy_relax.xml @ 30:3415a580926d draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 9ef881c2d3d5f240cbff33667b55f72cb82d9896"

<?xml version="1.0"?>
<tool id="hyphy_relax" name="HyPhy-RELAX" version="@VERSION@+galaxy1" profile="19.09">
    <description>Detect relaxed selection in a codon-based
    phylogenetic framework</description>
    <expand macro="bio_tools"/>
    <macros>
        <import>macros.xml</import>
    </macros>
    <expand macro="requirements"/>
    <command detect_errors="exit_code"><![CDATA[
        @SYMLINK_FILES@
        export OMP_NUM_THREADS="\${GALAXY_SLOTS:-1}" &&
        hyphy relax
            --alignment ./$input_file
            @INPUT_TREE@
            --models '$models'
            --code '$gencodeid'
            --test '$test'
            #if $reference:
                --reference '$reference'
            #end if
            @advanced_options@
            --output '$relax_output'
        @ERRORS@
    ]]></command>
    <inputs>
        <expand macro="inputs"/>
        <expand macro="gencode"/>
        <param argument="--models" type="select" label="Analysis Type" >
            <option value="All">All</option>
            <option value="Minimal">Minimal</option>
        </param>
        <param argument="--test" type="text" value="Unlabeled branches" optional="false" label="Branches to use as the test set">
            <sanitizer invalid_char="">
                <valid initial="default" />
            </sanitizer>
        </param>
        <param argument="--reference" type="text" optional="true" label="Branches to use as the reference set">
            <sanitizer invalid_char="">
                <valid initial="default" />
            </sanitizer>
        </param>
        <expand macro="srv" />
    </inputs>
    <outputs>
        <data name="relax_output" format="hyphy_results.json"/>
        <expand macro="alternative_model_output" />
    </outputs>
    <tests>
        <test>
            <param name="input_file" ftype="fasta" value="relax-in1.fa"/>
            <param name="input_nhx" ftype="nhx" value="relax-in1.nhx"/>
            <param name="test" value="TEST" />
            <output name="relax_output" file="relax-out1.json" compare="sim_size"/>
        </test>
        <test>
            <param name="input_file" ftype="nex" value="relax-in2.nex"/>
            <param name="srv_options" value="specify" />
            <param name="save_alternative_model" value="true" />
            <param name="test" value="PR" />
            <param name="srv" value="Yes" />
            <output name="relax_output" file="relax-out2-1.json" compare="sim_size"/>
            <output name="alternative_model" file="relax-out2-2.json" compare="sim_size"/>
        </test>
    </tests>
    <help><![CDATA[
RELAX: a test for selection differences
=======================================

What question does this method answer?
--------------------------------------

Is there evidence the strength of selection has been relaxed (or conversely intensified) on a specified group of lineages (TEST)
relative to a set of reference lineages (RELAX)? Importantly, RELAX is not designed to detect diversifying selection specifically.
We note that the RELAX framework can perform both this specific hypothesis test as well as fit a suite of descriptive models which address,
or example, overall rate differences between test and reference branches or lineage-specific inferences of selection relaxation.

Recommended Applications
------------------------

1. Testing for a systematic shift (relaxation / intensification) in the distribution of selection pressure associated with major biological transitions such as hosting switching in viruses, lifestyle evolution in bacteria (i.e. transition from free-living to endosymbiotic lifestyle
2. Comparing selective regimes between two subsets of branches in the tree, e.g. to investigate selective differences due an environmental/phenotypic changes.


Brief description
-----------------

RELAX (a random effects test of selection relaxation) uses a random
effects branch-site model framework to test whether a set of 'Test'
branches evolves under relaxed selection relative to a set of
'Reference' branches (R), as measured by the relaxation parameter (K).

Input
-----

    1. A *FASTA* sequence alignment.
    2. A phylogenetic tree in the *Newick* format that is further partitioned into one or two groups (_TEST_ or _TEST_ and _REFERENCE_). See http://hyphy.org/tutorials/phylotree/

Note: the names of sequences in the alignment must match the names of the sequences in the tree.


Output
------

A JSON file with analysis results (http://hyphy.org/resources/json-fields.pdf).

A custom visualization module for viewing these results is available (see http://vision.hyphy.org/RELAX for an example)

Further reading
---------------

http://hyphy.org/methods/selection-methods/#RELAX


Tool options
------------
::


    --code             Which genetic code to use

    --model            Which type of test to run
                            All : fit 4 different models [default]
                            Minimal: only perform a 2-model test of relaxation/intensification  [faster]


    ]]></help>
    <expand macro="citations">
        <citation type="doi">10.1093/molbev/msu400</citation>
    </expand>
</tool>