<tool id="mdanalysis_ramachandran_protein" name="Ramachandran Analysis" version="@TOOL_VERSION@+galaxy@GALAXY_VERSION@">
    <description>- Ramachandran plot for proteins</description>
    <macros>
        <import>macros.xml</import>
        <token name="@GALAXY_VERSION@">0</token>
    </macros>
    <expand macro="requirements">
        <requirement type="package" version="0.10.0">seaborn</requirement>
        <requirement type="package" version="2.10.0">h5py</requirement>
        <requirement type="package" version="2.11.1">jinja2</requirement>
    </expand>
    <command detect_errors="exit_code"><![CDATA[
        python '$__tool_directory__/ramachandran_auto_protein.py'
            --itraj '$trajin'
            --istr '$strin'
            --itrajext '$trajin.ext'
            --istrext '$strin.ext'
            --isegid1 '$segid1'
            #if $resid1 and $resid2:
                --iresid1 '$resid1'
                --iresid2 '$resid2'
            #end if
            #if $resname:
                --iresname '$resname'
            #end if
            --itemplatepath '$__tool_directory__'
            #if $groupby:
                --igroupby '$groupby'
            #end if
            --o_plot1 '$o_plot1'
            --o_plot2 '$o_plot2'
            --o_data1 '$o_data1'
            --o_html1 '$o_html1'
        2>&1
]]></command>
    <inputs>
        <expand macro="analysis_inputs" />
        <param name="segid1" type="text" value="PROA" label="Segment ID of the protein" help="A valid segment ID selection for the current molecular system">
            <validator type="regex" message="Maximum of 8 characters allowed.">^[a-zA-Z0-9]{1,8}$</validator>
        </param>
        <param name="groupby" type="select" optional="true" label="Groupby analysis" help="Optional, create a groupby of the selection using residue name or id">
            <option value="name">ResidueName</option>
            <option value="id">ResidueID</option>
        </param>
        <param name="resname" optional="true" type="text" label="Residue Name" help="Optional, choose a residue name to refine the selection, e.g. ALA">
            <validator type="regex" message="Maximum of 8 characters allowed.">^[a-zA-Z0-9]{1,8}$</validator>
        </param>
        <param name="resid1" optional="true" type="text" label="start Residue ID" help="Optional, choose a residue ID to refine the selection, e.g. 5">
            <validator type="regex" message="Maximum of 6 digits allowed.">^[0-9]{1,6}$</validator>
        </param>
        <param name="resid2" optional="true" type="text" label="end Residue ID" help="Optional, choose a residue ID to refine the selection, e.g. 10">
            <validator type="regex" message="Maximum of 6 digits allowed.">^[0-9]{1,6}$</validator>
        </param>
    </inputs>
    <outputs>
        <data format="png" name="o_plot1" label="MDAnalysis Ramachandran plot" />
        <data format="png" name="o_plot2" label="Seaborn Ramachandran plot" />
        <data format="h5" name="o_data1" label="Ramachandran in HDF5 format" />
        <data format="html" name="o_html1" label="Ramachandran plot summary" />
    </outputs>
    <tests>
        <test>
            <param name="trajin" value="test.dcd" ftype="dcd" />
            <param name="strin" value="test.pdb" ftype="pdb" />
            <param name="segid1" value="PRO" />
            <param name="groupby" value="name" />
            <output name="o_html1">
                <assert_contents>
                    <has_text text="table" />
                    <has_text text="(segid PRO) and resname MET" />
                    <has_text text="(segid PRO) and resname VAL" />
                </assert_contents>
            </output>
            <output name="o_plot1">
                <assert_contents>
                    <has_size value="53682" delta="3000" />
                </assert_contents>
            </output>
            <output name="o_plot2">
                <assert_contents>
                    <has_size value="31740" delta="3000" />
                </assert_contents>
            </output>
            <output name="o_data1">
                <assert_contents>
                    <has_size value="293824" delta="3000" />
                </assert_contents>
            </output>
        </test>
    </tests>
    <help><![CDATA[
.. class:: infomark

**What it does**

Creates a Ramachandran plot for proteins. All protein [φ,ψ] angles for a given segment ID are automatically selected for an entire trajectory and an averaged Ramachandran plot is returned. Optionally the selection can be refined by residue ID or residue name. Optionally the average Ramachandran plot can be deconvoluted and returned grouped by residue name or residue ID.


_____


.. class:: infomark

**Input**

       - Structure file (PDB)
       - Trajectory file (DCD).
       - Segment ID
       - Optionally: Group data by residue name or residue ID
       - Optionally: refine selection by residue ID range or residue name (e.g. ALA)

Note that a MDAnalysis 'segment' is a larger organizational unit, for example one protein or all the solvent molecules or simply the whole system.

_____


.. class:: infomark

**Output**

       - Image (as png) of the Ramachandran from MDanalyis with the allowed regions as a background.
       - Image (as png) of the Ramachandran plot as a distribution.
       - Data (H5 format). All phi, psi timeseries raw data in HDF5 format.
       - All plot images tabulated (in html). To view the HTML in Galaxy this tool must be added to the allowlist by a Galaxy Admin.
    ]]></help>
    <expand macro="citations" />
</tool>