annotate mixomics_plotindiv.xml @ 2:c8533e9298e5 draft

"planemo upload for repository https://gitlab.com/bilille/galaxy-viscorvar commit 8cb5630238352459037b3647eebfabb5554566f6-dirty"

<tool id="mixomics_plotindiv" name="mixOmics plotIndiv" version="@TOOL_VERSION@+galaxy1" profile="16.04" workflow_compatible="true">

    <description>provides scatter plots for individuals (experimental units) representation in (sparse)(I)PCA,(regularized)CCA, (sparse)PLS(DA) and (sparse)(R)GCCA(DA)</description>

    <macros>
        <import>macros.xml</import>
        <import>macros_mixomics.xml</import>
    </macros>

    <expand macro="requirements"/>
    <expand macro="stdio"/>

    <command detect_errors="aggressive"><![CDATA[

        @COMMAND_RSCRIPT@/mixomics_plotindiv.R

        --input_rdata $input_rdata

        $adv.legend
        $adv.ellipse

        --output_pdf $output_pdf

        @COMMAND_LOG_EXIT@

    ]]></command>

    <inputs>
        <param name="input_rdata" type="data" format="rdata"
               label="Input RData file from (sparse)(I)PCA, (regularized)CCA, (sparse)PLS(DA) or (sparse)(R)GCCA(DA)"
               help="This is the RData output file from the block.splsda function." />
        <section name="adv" title="Advanced Options" expanded="false">
            <param name="legend" type="boolean" checked="true" truevalue="--legend" falsevalue=""
                   label="Plot legend" />
            <param name="ellipse" type="boolean" checked="true" truevalue="--ellipse" falsevalue=""
                   label="Plot ellipse plots" />
        </section>
    </inputs>

    <outputs>
        <data name="output_pdf" format="pdf" label="plotIndiv.pdf" />
    </outputs>

    <tests>
        <test>
            <param name="input_rdata" value="out_rdata.rdata" />
            <output name="output_pdf" value="out_plotIndiv.pdf" />
        </test>
    </tests>

    <help><![CDATA[

@HELP_AUTHORS@

==================
mixOmics plotIndiv
==================

-----------
Description
-----------

The plotIndiv function is part of the mixOmics package for exploration and integration of Omics datasets.
Provides scatter plots for individuals (experimental units) representation in (sparse)(I)PCA,(regularized)CCA, (sparse)PLS(DA) and (sparse)(R)GCCA(DA).

-----------------
Workflow position
-----------------

**Upstream tools**

======================= =================================== ========
Name                    Output file                         Format
======================= =================================== ========
mixOmics.block.splsda   mixomics_blocksplsda_output.RData   rdata
======================= =================================== ========

---------------------------------------------------

-----------
Input files
-----------

+-------------------------------+------------+
| Parameter : num + label       |   Format   |
+===============================+============+
| 1 : Rdata block.splsda output |   Rdata    |
+-------------------------------+------------+

----------
Parameters
----------

Advanced options:
=================

Plot legend

Plot ellipse plots


@HELP_MANUAL@

------------
Output files
------------

plotIndiv.pdf
    A pdf file with scatter plots for individuals

    ]]></help>

    <expand macro="citations" />

</tool>