annotate qiime2__feature_table__core_features.xml @ 1:3ab02629e494 draft

planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 69da7976573cc07a363ac66bdacc9269d7cd3732
author q2d2
date Fri, 13 Jan 2023 22:55:35 +0000
parents db935a4cfe8b
children 13e8049936ee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
db935a4cfe8b 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'?>
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
2 <!--
1
3ab02629e494 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
3 Copyright (c) 2023, QIIME 2 development team.
0
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
4
db935a4cfe8b 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)
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
6 -->
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
7 <!--
db935a4cfe8b 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:
1
3ab02629e494 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
9 q2galaxy (version: 2022.11.1)
0
db935a4cfe8b 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:
1
3ab02629e494 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
11 qiime2 (version: 2022.11.1)
0
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
12 -->
1
3ab02629e494 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
13 <tool name="qiime2 feature-table core-features" id="qiime2__feature_table__core_features" version="2022.11.1+q2galaxy.2022.11.1.2" profile="22.05" license="BSD-3-Clause">
0
db935a4cfe8b 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>Identify core features in table</description>
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
15 <requirements>
1
3ab02629e494 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
16 <container type="docker">quay.io/qiime2/core:2022.11</container>
0
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
17 </requirements>
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
18 <version_command>q2galaxy version feature_table</version_command>
1
3ab02629e494 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
19 <command detect_errors="exit_code">q2galaxy run feature_table core_features '$inputs'</command>
0
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
20 <configfiles>
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
21 <inputs name="inputs" data_style="paths"/>
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
22 </configfiles>
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
23 <inputs>
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
24 <param name="table" type="data" format="qza" label="table: FeatureTable[Frequency]" help="[required] The feature table to use in core features calculations.">
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
25 <options options_filter_attribute="metadata.semantic_type">
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
26 <filter type="add_value" value="FeatureTable[Frequency]"/>
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
27 </options>
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
28 <validator type="expression" message="Incompatible type">hasattr(value.metadata, "semantic_type") and value.metadata.semantic_type in ['FeatureTable[Frequency]']</validator>
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
29 </param>
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
30 <section name="__q2galaxy__GUI__section__extra_opts__" title="Click here for additional options">
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
31 <param name="min_fraction" type="float" min="1e-06" max="0.999999" value="0.5" label="min_fraction: Float % Range(0.0, 1.0, inclusive_start=False)" help="[default: 0.5] The minimum fraction of samples that a feature must be observed in for that feature to be considered a core feature."/>
db935a4cfe8b 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 name="max_fraction" type="float" min="0.0" max="1.0" value="1.0" label="max_fraction: Float % Range(0.0, 1.0, inclusive_end=True)" help="[default: 1.0] The maximum fraction of samples that a feature must be observed in for that feature to be considered a core feature."/>
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
33 <param name="steps" type="integer" min="2" value="11" label="steps: Int % Range(2, None)" help="[default: 11] The number of steps to take between `min_fraction` and `max_fraction` for core features calculations. This parameter has no effect if `min_fraction` and `max_fraction` are the same value."/>
db935a4cfe8b 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>
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
35 </inputs>
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
36 <outputs>
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table 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"/>
db935a4cfe8b 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>
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
39 <tests/>
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
40 <help>
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
41 QIIME 2: feature-table core-features
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
42 ====================================
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
43 Identify core features in table
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
44
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
45
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
46 Outputs:
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
47 --------
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
48 :visualization.qzv: &lt;no description&gt;
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
49
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
50 |
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
51
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
52 Description:
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
53 ------------
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
54 Identify "core" features, which are features observed in a user-defined fraction of the samples. Since the core features are a function of the fraction of samples that the feature must be observed in to be considered core, this is computed over a range of fractions defined by the `min_fraction`, `max_fraction`, and `steps` parameters.
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
55
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
56
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
57 |
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
58
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
59 </help>
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
60 <citations>
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
61 <citation type="doi">10.1038/s41587-019-0209-9</citation>
db935a4cfe8b 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>
db935a4cfe8b planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__feature_table commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
63 </tool>