annotate qiime2__feature_table__rarefy.xml @ 5:adf22a045073 draft default tip

planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 5f71b597c9495eae67a447744fded834f56ca1f7
author q2d2
date Wed, 30 Oct 2024 19:48:58 +0000
parents 76f44ad77e0c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
1 <?xml version='1.0' encoding='utf-8'?>
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
2 <!--
3
b8a1673803a8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents: 2
diff changeset
3 Copyright (c) 2024, QIIME 2 development team.
0
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
4
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
5 Distributed under the terms of the Modified BSD License. (SPDX: BSD-3-Clause)
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
6 -->
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
7 <!--
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
8 This tool was automatically generated by:
5
adf22a045073 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents: 4
diff changeset
9 q2galaxy (version: 2024.10.0)
0
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
10 for:
5
adf22a045073 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents: 4
diff changeset
11 qiime2 (version: 2024.10.1)
0
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
12 -->
5
adf22a045073 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents: 4
diff changeset
13 <tool name="qiime2 feature-table rarefy" id="qiime2__feature_table__rarefy" version="2024.10.0+q2galaxy.2024.10.0" profile="22.05" license="BSD-3-Clause">
0
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
14 <description>Rarefy table</description>
5
adf22a045073 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents: 4
diff changeset
15 <xrefs>
adf22a045073 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents: 4
diff changeset
16 <xref type="bio.tools">qiime2</xref>
adf22a045073 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents: 4
diff changeset
17 </xrefs>
0
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
18 <requirements>
5
adf22a045073 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents: 4
diff changeset
19 <container type="docker">quay.io/qiime2/amplicon:2024.10</container>
0
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
20 </requirements>
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
21 <version_command>q2galaxy version feature_table</version_command>
1
985c7f96ce2a planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
22 <command detect_errors="exit_code">q2galaxy run feature_table rarefy '$inputs'</command>
0
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
23 <configfiles>
3
b8a1673803a8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents: 2
diff changeset
24 <inputs name="inputs" data_style="staging_path_and_source_path"/>
0
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
25 </configfiles>
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
26 <inputs>
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
27 <param name="table" type="data" format="qza" label="table: FeatureTable[Frequency]" help="[required] The feature table to be rarefied.">
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
28 <options options_filter_attribute="metadata.semantic_type">
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
29 <filter type="add_value" value="FeatureTable[Frequency]"/>
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
30 </options>
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
31 <validator type="expression" message="Incompatible type">hasattr(value.metadata, "semantic_type") and value.metadata.semantic_type in ['FeatureTable[Frequency]']</validator>
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
32 </param>
1
985c7f96ce2a planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
33 <param name="sampling_depth" type="integer" min="1" value="" label="sampling_depth: Int % Range(1, None)" help="[required] The total frequency that each sample should be rarefied to. Samples where the sum of frequencies is less than the sampling depth will be not be included in the resulting table."/>
0
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
34 <section name="__q2galaxy__GUI__section__extra_opts__" title="Click here for additional options">
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
35 <param name="with_replacement" type="boolean" truevalue="__q2galaxy__::literal::True" falsevalue="__q2galaxy__::literal::False" label="with_replacement: Bool" help="[default: No] Rarefy with replacement by sampling from the multinomial distribution instead of rarefying without replacement."/>
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
36 </section>
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
37 </inputs>
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
38 <outputs>
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
39 <data name="rarefied_table" format="qza" label="${tool.name} on ${on_string}: rarefied_table.qza" from_work_dir="rarefied_table.qza"/>
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
40 </outputs>
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
41 <tests/>
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
42 <help>
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
43 QIIME 2: feature-table rarefy
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
44 =============================
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
45 Rarefy table
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
46
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
47
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
48 Outputs:
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
49 --------
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
50 :rarefied_table.qza: The resulting rarefied feature table.
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
51
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
52 |
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
53
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
54 Description:
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
55 ------------
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
56 Subsample frequencies from all samples so that the sum of frequencies in each sample is equal to sampling-depth.
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
57
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
58
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
59 |
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
60
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
61 </help>
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
62 <citations>
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
63 <citation type="doi">10.1186/s40168-017-0237-y</citation>
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
64 <citation type="doi">10.1038/s41587-019-0209-9</citation>
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
65 </citations>
c234fbc63b48 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
66 </tool>