annotate qiime2__demux__summarize.xml @ 4:acb0f8837379 draft default tip

planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit c7e80dcda727ce63b42aa8a946e9330310929797
author q2d2
date Mon, 03 Jun 2024 23:18:02 +0000
parents 84877e27c82c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
1 <?xml version='1.0' encoding='utf-8'?>
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
2 <!--
3
84877e27c82c planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents: 2
diff changeset
3 Copyright (c) 2024, QIIME 2 development team.
0
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
4
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
5 Distributed under the terms of the Modified BSD License. (SPDX: BSD-3-Clause)
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
6 -->
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
7 <!--
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
8 This tool was automatically generated by:
4
acb0f8837379 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit c7e80dcda727ce63b42aa8a946e9330310929797
q2d2
parents: 3
diff changeset
9 q2galaxy (version: 2024.5.0)
0
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
10 for:
4
acb0f8837379 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit c7e80dcda727ce63b42aa8a946e9330310929797
q2d2
parents: 3
diff changeset
11 qiime2 (version: 2024.5.0)
0
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
12 -->
4
acb0f8837379 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit c7e80dcda727ce63b42aa8a946e9330310929797
q2d2
parents: 3
diff changeset
13 <tool name="qiime2 demux summarize" id="qiime2__demux__summarize" version="2024.5.0+q2galaxy.2024.5.0" profile="22.05" license="BSD-3-Clause">
0
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
14 <description>Summarize counts per sample.</description>
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
15 <requirements>
4
acb0f8837379 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit c7e80dcda727ce63b42aa8a946e9330310929797
q2d2
parents: 3
diff changeset
16 <container type="docker">quay.io/qiime2/amplicon:2024.5</container>
0
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
17 </requirements>
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
18 <version_command>q2galaxy version demux</version_command>
1
222b50c1cb52 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
19 <command detect_errors="exit_code">q2galaxy run demux summarize '$inputs'</command>
0
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
20 <configfiles>
3
84877e27c82c planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents: 2
diff changeset
21 <inputs name="inputs" data_style="staging_path_and_source_path"/>
0
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
22 </configfiles>
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
23 <inputs>
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
24 <param name="data" type="data" format="qza" label="data: SampleData[SequencesWithQuality | PairedEndSequencesWithQuality | JoinedSequencesWithQuality]" help="[required] The demultiplexed sequences to be summarized.">
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
25 <options options_filter_attribute="metadata.semantic_type">
4
acb0f8837379 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit c7e80dcda727ce63b42aa8a946e9330310929797
q2d2
parents: 3
diff changeset
26 <filter type="add_value" value="SampleData[PairedEndSequencesWithQuality]"/>
3
84877e27c82c planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents: 2
diff changeset
27 <filter type="add_value" value="SampleData[SequencesWithQuality]"/>
0
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
28 <filter type="add_value" value="SampleData[JoinedSequencesWithQuality]"/>
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
29 </options>
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
30 <validator type="expression" message="Incompatible type">hasattr(value.metadata, "semantic_type") and value.metadata.semantic_type in ['SampleData[JoinedSequencesWithQuality]', 'SampleData[PairedEndSequencesWithQuality]', 'SampleData[SequencesWithQuality]']</validator>
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
31 </param>
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
32 <section name="__q2galaxy__GUI__section__extra_opts__" title="Click here for additional options">
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
33 <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."/>
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
34 </section>
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
35 </inputs>
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
36 <outputs>
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
37 <data name="visualization" format="qzv" label="${tool.name} on ${on_string}: visualization.qzv" from_work_dir="visualization.qzv"/>
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
38 </outputs>
1
222b50c1cb52 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
39 <tests>
222b50c1cb52 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
40 <test>
222b50c1cb52 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
41 <param name="data" value="summarize.test0.demux.qza" ftype="qza"/>
222b50c1cb52 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
42 <output name="visualization" ftype="qzv">
222b50c1cb52 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
43 <assert_contents>
222b50c1cb52 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
44 <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">
222b50c1cb52 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
45 <has_line_matching expression="type: Visualization"/>
222b50c1cb52 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
46 </has_archive_member>
222b50c1cb52 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
47 </assert_contents>
222b50c1cb52 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
48 </output>
222b50c1cb52 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
49 </test>
222b50c1cb52 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
50 </tests>
0
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
51 <help>
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
52 QIIME 2: demux summarize
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
53 ========================
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
54 Summarize counts per sample.
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
55
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
56
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
57 Outputs:
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
58 --------
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
59 :visualization.qzv: &lt;no description&gt;
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
60
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
61 |
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
62
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
63 Description:
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
64 ------------
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
65 Summarize counts per sample for all samples, and generate interactive positional quality plots based on `n` randomly selected sequences.
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
66
1
222b50c1cb52 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
67 Examples:
222b50c1cb52 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
68 ---------
222b50c1cb52 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
69
222b50c1cb52 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
70 demux
222b50c1cb52 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
71 *****
222b50c1cb52 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
72 Using the ``qiime2 demux summarize`` tool:
222b50c1cb52 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
73 #. Set *"data"* to ``#: demux.qza``
222b50c1cb52 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
74 #. Press the ``Execute`` button.
222b50c1cb52 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
75
222b50c1cb52 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
76
0
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
77
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
78 |
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
79
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
80 </help>
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
81 <citations>
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
82 <citation type="doi">10.1038/s41587-019-0209-9</citation>
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
83 </citations>
3e85de166340 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
84 </tool>