annotate qiime2__demux__summarize.xml @ 1:222b50c1cb52 draft

planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732

<?xml version='1.0' encoding='utf-8'?>
<!--
Copyright (c) 2023, 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.11.1)
for:
    qiime2 (version: 2022.11.1)
-->
<tool name="qiime2 demux summarize" id="qiime2__demux__summarize" version="2022.11.1+q2galaxy.2022.11.1.2" profile="22.05" license="BSD-3-Clause">
    <description>Summarize counts per sample.</description>
    <requirements>
        <container type="docker">quay.io/qiime2/core:2022.11</container>
    </requirements>
    <version_command>q2galaxy version demux</version_command>
    <command detect_errors="exit_code">q2galaxy run demux summarize '$inputs'</command>
    <configfiles>
        <inputs name="inputs" data_style="paths"/>
    </configfiles>
    <inputs>
        <param name="data" type="data" format="qza" label="data: SampleData[SequencesWithQuality | PairedEndSequencesWithQuality | JoinedSequencesWithQuality]" help="[required]  The demultiplexed sequences to be summarized.">
            <options options_filter_attribute="metadata.semantic_type">
                <filter type="add_value" value="SampleData[SequencesWithQuality]"/>
                <filter type="add_value" value="SampleData[JoinedSequencesWithQuality]"/>
                <filter type="add_value" value="SampleData[PairedEndSequencesWithQuality]"/>
            </options>
            <validator type="expression" message="Incompatible type">hasattr(value.metadata, "semantic_type") and value.metadata.semantic_type in ['SampleData[JoinedSequencesWithQuality]', 'SampleData[PairedEndSequencesWithQuality]', 'SampleData[SequencesWithQuality]']</validator>
        </param>
        <section name="__q2galaxy__GUI__section__extra_opts__" title="Click here for additional options">
            <param name="n" type="integer" value="10000" label="n: Int" help="[default: 10000]  The number of sequences that should be selected at random for quality score plots. The quality plots will present the average positional qualities across all of the sequences selected. If input sequences are paired end, plots will be generated for both forward and reverse reads for the same `n` sequences."/>
        </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="data" value="summarize.test0.demux.qza" ftype="qza"/>
            <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: demux summarize
========================
Summarize counts per sample.


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

|  

Description:
------------
Summarize counts per sample for all samples, and generate interactive positional quality plots based on `n` randomly selected sequences.

Examples:
---------

demux
*****
Using the ``qiime2 demux summarize`` tool:
 #. Set *"data"* to ``#: demux.qza``
 #. Press the ``Execute`` button.



|  

</help>
    <citations>
        <citation type="doi">10.1038/s41587-019-0209-9</citation>
    </citations>
</tool>