view qiime2__emperor__plot.xml @ 3:00b78cb5acb5 draft

planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__emperor commit 389df0134cd0763dcf02aac6e623fc15f8861c1e

<?xml version='1.0' encoding='utf-8'?>
<!--
Copyright (c) 2024, QIIME 2 development team.

Distributed under the terms of the Modified BSD License. (SPDX: BSD-3-Clause)
-->
<!--
This tool was automatically generated by:
    q2galaxy (version: 2024.2.1)
for:
    qiime2 (version: 2024.2.0)
-->
<tool name="qiime2 emperor plot" id="qiime2__emperor__plot" version="2024.2.0+q2galaxy.2024.2.1" profile="22.05" license="BSD-3-Clause">
    <description>Visualize and Interact with Principal Coordinates Analysis Plots</description>
    <requirements>
        <container type="docker">quay.io/qiime2/amplicon:2024.2</container>
    </requirements>
    <version_command>q2galaxy version emperor</version_command>
    <command detect_errors="exit_code">q2galaxy run emperor plot '$inputs'</command>
    <configfiles>
        <inputs name="inputs" data_style="staging_path_and_source_path"/>
    </configfiles>
    <inputs>
        <param name="pcoa" type="data" format="qza" label="pcoa: PCoAResults" help="[required]  The principal coordinates matrix to be plotted.">
            <options options_filter_attribute="metadata.semantic_type">
                <filter type="add_value" value="PCoAResults"/>
            </options>
            <validator type="expression" message="Incompatible type">hasattr(value.metadata, "semantic_type") and value.metadata.semantic_type in ['PCoAResults']</validator>
        </param>
        <repeat name="metadata" min="1" help="[required]  The sample metadata." title="metadata: Metadata">
            <conditional name="__q2galaxy__GUI__conditional__metadata__">
                <param name="type" type="select" label="metadata: Metadata">
                    <option value="tsv" selected="true">Metadata from TSV</option>
                    <option value="qza">Metadata from Artifact</option>
                </param>
                <when value="tsv">
                    <param name="source" type="data" format="tabular,qiime2.tabular" label="Metadata Source"/>
                </when>
                <when value="qza">
                    <param name="source" type="data" format="qza" label="Metadata Source"/>
                </when>
            </conditional>
        </repeat>
        <section name="__q2galaxy__GUI__section__extra_opts__" title="Click here for additional options">
            <repeat name="custom_axes" help="[optional]  Numeric sample metadata columns that should be included as axes in the Emperor plot." title="custom_axes: List[Str]">
                <param name="element" type="text" label="element: Str" help="[required]">
                    <sanitizer>
                        <valid initial="string.printable"/>
                    </sanitizer>
                    <validator type="expression" message="Please verify this parameter.">value is not None and len(value) &gt; 0</validator>
                </param>
            </repeat>
            <param name="ignore_missing_samples" type="boolean" truevalue="__q2galaxy__::literal::True" falsevalue="__q2galaxy__::literal::False" label="ignore_missing_samples: Bool" help="[default: No]  This will suppress the error raised when the coordinates matrix contains samples that are not present in the metadata. Samples without metadata are included by setting all metadata values to: &quot;This sample has no metadata&quot;. This flag is only applied if at least one sample is present in both the coordinates matrix and the metadata."/>
            <param name="ignore_pcoa_features" type="boolean" truevalue="__q2galaxy__::literal::True" falsevalue="__q2galaxy__::literal::False" label="ignore_pcoa_features: Bool" help="[default: No]  Biplot arrows cannot be visualized using this method. If you want to visualize biplot arrows use the `biplot` method. Enabling this setting will ignore any PCoA features that are present, otherwise, if PCoA features are detected an error will be raised."/>
        </section>
    </inputs>
    <outputs>
        <data name="visualization" format="qzv" label="${tool.name} on ${on_string}: visualization.qzv" from_work_dir="visualization.qzv"/>
    </outputs>
    <tests>
        <test>
            <param name="pcoa" value="plot.test0.pcoa-result.qza" ftype="qza"/>
            <repeat name="metadata">
                <conditional name="__q2galaxy__GUI__conditional__metadata__">
                    <param name="type" value="tsv"/>
                    <param name="source" value="plot.test0.sample-metadata.tsv" ftype="qiime2.tabular"/>
                </conditional>
            </repeat>
            <output name="visualization" ftype="qzv">
                <assert_contents>
                    <has_archive_member path="[0-9a-f]{8}-[0-9a-f]{4}-[4][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}\/metadata.yaml">
                        <has_line_matching expression="type: Visualization"/>
                    </has_archive_member>
                </assert_contents>
            </output>
        </test>
    </tests>
    <help>
QIIME 2: emperor plot
=====================
Visualize and Interact with Principal Coordinates Analysis Plots


Outputs:
--------
:visualization.qzv: &lt;no description&gt;

|  

Description:
------------
Generates an interactive ordination plot where the user can visually integrate sample metadata.

Examples:
---------

emperor_plot
************
Using the ``qiime2 emperor plot`` tool:
 #. Set *"pcoa"* to ``#: pcoa-result.qza``
 #. For *"metadata"*:

    - Perform the following steps.

      #. Leave as ``Metadata from TSV``
      #. Set *"Metadata Source"* to ``sample-metadata.tsv``


 #. Press the ``Execute`` button.

Once completed, for the new entry in your history, use the ``Edit`` button to set the name as follows:
 (Renaming is optional, but it will make any subsequent steps easier to complete.)

 .. list-table::
    :align: left
    :header-rows: 1

    * - History Name
      - *"Name"* to set (be sure to press ``Save``)
    * - ``#: qiime2 emperor plot [...] : visualization.qzv``
      - ``plot.qzv``


|  

</help>
    <citations>
        <citation type="doi">10.1186/2047-217X-2-16</citation>
        <citation type="doi">10.1016/j.chom.2016.12.009</citation>
        <citation type="doi">10.1038/s41587-019-0209-9</citation>
    </citations>
</tool>