annotate hyphy_relax.xml @ 18:b8bdfac5a326 draft

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

<?xml version="1.0"?>
<tool id="hyphy_relax" name="HyPhy-RELAX" version="@VERSION@+galaxy0" profile="19.09">
    <description>Detect relaxed selection in a codon-based
    phylogenetic framework</description>
    <macros>
        <import>macros.xml</import>
    </macros>
    <expand macro="requirements"/>
    <command detect_errors="exit_code"><![CDATA[
        ln -s '$input_file' relax_input.fa &&
        ln -s '$input_nhx' relax_input.nhx &&

        export OMP_NUM_THREADS="\${GALAXY_SLOTS:-1}" &&
        hyphy relax
            --alignment ./relax_input.fa
            --tree ./relax_input.nhx
            --models '$analysisType'
            --code '$gencodeid'
            #if $treeAnnotations == "2":
                --test TEST
                --reference REFERENCE
            #else:
                --test TEST
            #end if
            > '$relax_log'
    ]]></command>
    <inputs>
        <expand macro="inputs"/>
        <expand macro="gencode"/>
        <param argument="--model" name="analysisType" type="select" label="Analysis Type" >
            <option value="All">All</option>
            <option value="Minimal">Minimal</option>
        </param>
        <param name="treeAnnotations" type="select" label="Tree Annotations" help = "Is there one or two sets of annotated branches in the Newick file?">
            <option value="1">TEST only</option>
            <option value="2">TEST and REFERENCE</option>
        </param>
    </inputs>
    <outputs>
        <data name="relax_log" format="txt"/>
        <data name="relax_output" format="hyphy_results.json" from_work_dir="relax_input.fa.RELAX.json"/>
    </outputs>
    <tests>
        <test>
            <param name="input_file" ftype="fasta" value="relax-in1.fa"/>
            <param name="input_nhx" ftype="nhx" value="relax-in1.nhx"/>
            <output name="relax_output" file="relax-out1.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>