annotate qiime2__demux__subsample_single.xml @ 7:5f29bf108ba3 draft default tip

planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9436cc47c72b58a6a3d3a5c2ee075689c2926ef0
author q2d2
date Tue, 15 Jul 2025 21:49:30 +0000
parents 8199a544a842
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3c0e647d6101 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'?>
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
2 <!--
6
8199a544a842 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit b1fccfb38b4873cd4699743033449014a2978e7d
q2d2
parents: 5
diff changeset
3 Copyright (c) 2025, QIIME 2 development team.
0
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
4
3c0e647d6101 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)
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
6 -->
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
7 <!--
3c0e647d6101 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:
7
5f29bf108ba3 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9436cc47c72b58a6a3d3a5c2ee075689c2926ef0
q2d2
parents: 6
diff changeset
9 q2galaxy (version: 2025.7.0)
0
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
10 for:
7
5f29bf108ba3 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9436cc47c72b58a6a3d3a5c2ee075689c2926ef0
q2d2
parents: 6
diff changeset
11 qiime2 (version: 2025.7.0)
0
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
12 -->
7
5f29bf108ba3 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9436cc47c72b58a6a3d3a5c2ee075689c2926ef0
q2d2
parents: 6
diff changeset
13 <tool name="qiime2 demux subsample-single" id="qiime2__demux__subsample_single" version="2025.7.0+q2galaxy.2025.7.0" profile="22.05" license="BSD-3-Clause">
0
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
14 <description>Subsample single-end sequences without replacement.</description>
5
76384b6b3d90 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents: 4
diff changeset
15 <xrefs>
76384b6b3d90 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents: 4
diff changeset
16 <xref type="bio.tools">qiime2</xref>
76384b6b3d90 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents: 4
diff changeset
17 </xrefs>
0
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
18 <requirements>
7
5f29bf108ba3 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9436cc47c72b58a6a3d3a5c2ee075689c2926ef0
q2d2
parents: 6
diff changeset
19 <container type="docker">quay.io/qiime2/amplicon:2025.7</container>
0
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
20 </requirements>
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
21 <version_command>q2galaxy version demux</version_command>
1
12747289fc83 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
22 <command detect_errors="exit_code">q2galaxy run demux subsample_single '$inputs'</command>
0
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
23 <configfiles>
3
4c598bbefcbb planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents: 2
diff changeset
24 <inputs name="inputs" data_style="staging_path_and_source_path"/>
0
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
25 </configfiles>
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
26 <inputs>
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
27 <param name="sequences" type="data" format="qza" label="sequences: SampleData[SequencesWithQuality | PairedEndSequencesWithQuality]" help="[required] The demultiplexed sequences to be subsampled.">
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
28 <options options_filter_attribute="metadata.semantic_type">
4
26139ebc17ea planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit c7e80dcda727ce63b42aa8a946e9330310929797
q2d2
parents: 3
diff changeset
29 <filter type="add_value" value="SampleData[PairedEndSequencesWithQuality]"/>
3
4c598bbefcbb planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents: 2
diff changeset
30 <filter type="add_value" value="SampleData[SequencesWithQuality]"/>
0
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
31 </options>
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
32 <validator type="expression" message="Incompatible type">hasattr(value.metadata, "semantic_type") and value.metadata.semantic_type in ['SampleData[PairedEndSequencesWithQuality]', 'SampleData[SequencesWithQuality]']</validator>
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
33 </param>
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
34 <param name="fraction" type="float" min="1e-06" max="0.999999" value="" label="fraction: Float % Range(0, 1, inclusive_start=False)" help="[required] The fraction of sequences to retain in subsample."/>
7
5f29bf108ba3 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9436cc47c72b58a6a3d3a5c2ee075689c2926ef0
q2d2
parents: 6
diff changeset
35 <section name="__q2galaxy__GUI__section__extra_opts__" title="Click here for additional options">
5f29bf108ba3 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9436cc47c72b58a6a3d3a5c2ee075689c2926ef0
q2d2
parents: 6
diff changeset
36 <param name="drop_empty" type="boolean" truevalue="__q2galaxy__::literal::True" falsevalue="__q2galaxy__::literal::False" label="drop_empty: Bool" help="[default: No] Whether to drop empty samples."/>
5f29bf108ba3 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9436cc47c72b58a6a3d3a5c2ee075689c2926ef0
q2d2
parents: 6
diff changeset
37 </section>
0
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
38 </inputs>
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
39 <outputs>
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
40 <data name="subsampled_sequences" format="qza" label="${tool.name} on ${on_string}: subsampled_sequences.qza" from_work_dir="subsampled_sequences.qza"/>
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
41 </outputs>
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
42 <tests/>
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
43 <help>
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
44 QIIME 2: demux subsample-single
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
45 ===============================
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
46 Subsample single-end sequences without replacement.
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
47
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
48
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
49 Outputs:
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
50 --------
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
51 :subsampled_sequences.qza: The subsampled sequences.
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
52
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
53 |
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
54
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
55 Description:
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
56 ------------
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
57 Generate a random subsample of single-end sequences containing approximately the fraction of input sequences specified by the fraction parameter. The number of output samples will always be equal to the number of input samples, even if some of those samples contain no sequences after subsampling.
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
58
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
59
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
60 |
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
61
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
62 </help>
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
63 <citations>
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
64 <citation type="doi">10.1038/s41587-019-0209-9</citation>
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
65 </citations>
3c0e647d6101 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__demux commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
66 </tool>