view qiime2__diversity__alpha_correlation.xml @ 0:4a62b47071f5 draft

planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
author q2d2
date Mon, 29 Aug 2022 19:32:51 +0000
parents
children 9235f6a16926
line wrap: on
line source

<?xml version='1.0' encoding='utf-8'?>
<!--
Copyright (c) 2022, 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: 2022.8.1)
for:
    qiime2 (version: 2022.8.1)
-->
<tool name="qiime2 diversity alpha-correlation" id="qiime2__diversity__alpha_correlation" version="2022.8.0+q2galaxy.2022.8.1.2" profile="22.05" license="BSD-3-Clause">
    <description>Alpha diversity correlation</description>
    <requirements>
        <container type="docker">quay.io/qiime2/core:2022.8</container>
    </requirements>
    <version_command>q2galaxy version diversity</version_command>
    <command detect_errors="aggressive">q2galaxy run diversity alpha_correlation '$inputs'</command>
    <configfiles>
        <inputs name="inputs" data_style="paths"/>
    </configfiles>
    <inputs>
        <param name="alpha_diversity" type="data" format="qza" label="alpha_diversity: SampleData[AlphaDiversity]" help="[required]  Vector of alpha diversity values by sample.">
            <options options_filter_attribute="metadata.semantic_type">
                <filter type="add_value" value="SampleData[AlphaDiversity]"/>
            </options>
            <validator type="expression" message="Incompatible type">hasattr(value.metadata, "semantic_type") and value.metadata.semantic_type in ['SampleData[AlphaDiversity]']</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">
            <param name="method" type="select" label="method: Str % Choices('spearman', 'pearson')" display="radio">
                <option value="spearman" selected="true">spearman</option>
                <option value="pearson">pearson</option>
            </param>
            <param name="intersect_ids" type="boolean" truevalue="__q2galaxy__::literal::True" falsevalue="__q2galaxy__::literal::False" label="intersect_ids: Bool" help="[default: No]  If supplied, IDs that are not found in both the alpha diversity vector and metadata will be discarded before calculating the correlation. Default behavior is to error on any mismatched IDs."/>
        </section>
    </inputs>
    <outputs>
        <data name="visualization" format="qzv" label="${tool.name} on ${on_string}: visualization.qzv" from_work_dir="visualization.qzv"/>
    </outputs>
    <tests/>
    <help>
QIIME 2: diversity alpha-correlation
====================================
Alpha diversity correlation


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

|  

Description:
------------
Determine whether numeric sample metadata columns are correlated with alpha diversity.


|  

</help>
    <citations>
        <citation type="doi">https://doi.org/10.1098/rspl.1895.0041</citation>
        <citation type="doi">https://doi.org/10.2307/1422689</citation>
        <citation type="doi">10.1038/s41587-019-0209-9</citation>
    </citations>
</tool>