Mercurial > repos > q2d2 > qiime2__diversity__alpha_rarefaction

comparison qiime2__diversity__alpha_rarefaction.xml @ 0:5f6db74d2445 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
author q2d2
date Mon, 29 Aug 2022 19:32:27 +0000
parents
children ed21beb2e60f
comparison
equal deleted inserted replaced
-1:000000000000 0:5f6db74d2445
1 <?xml version='1.0' encoding='utf-8'?>
2 <!--
3 Copyright (c) 2022, QIIME 2 development team.
4
5 Distributed under the terms of the Modified BSD License. (SPDX: BSD-3-Clause)
6 -->
7 <!--
8 This tool was automatically generated by:
9 q2galaxy (version: 2022.8.1)
10 for:
11 qiime2 (version: 2022.8.1)
12 -->
13 <tool name="qiime2 diversity alpha-rarefaction" id="qiime2__diversity__alpha_rarefaction" version="2022.8.0+q2galaxy.2022.8.1.2" profile="22.05" license="BSD-3-Clause">
14 <description>Alpha rarefaction curves</description>
15 <requirements>
16 <container type="docker">quay.io/qiime2/core:2022.8</container>
17 </requirements>
18 <version_command>q2galaxy version diversity</version_command>
19 <command detect_errors="aggressive">q2galaxy run diversity alpha_rarefaction '$inputs'</command>
20 <configfiles>
21 <inputs name="inputs" data_style="paths"/>
22 </configfiles>
23 <inputs>
24 <param name="table" type="data" format="qza" label="table: FeatureTable[Frequency]" help="[required] Feature table to compute rarefaction curves from.">
25 <options options_filter_attribute="metadata.semantic_type">
26 <filter type="add_value" value="FeatureTable[Frequency]"/>
27 </options>
28 <validator type="expression" message="Incompatible type">hasattr(value.metadata, "semantic_type") and value.metadata.semantic_type in ['FeatureTable[Frequency]']</validator>
29 </param>
30 <param name="max_depth" type="integer" min="1" value="" label="max_depth: Int % Range(1, None)" help="[required] The maximum rarefaction depth. Must be greater than min_depth."/>
31 <section name="__q2galaxy__GUI__section__extra_opts__" title="Click here for additional options">
32 <param name="phylogeny" type="data" format="qza" optional="true" label="phylogeny: Phylogeny[Rooted]" help="[optional] Optional phylogeny for phylogenetic metrics.">
33 <options options_filter_attribute="metadata.semantic_type">
34 <filter type="add_value" value="Phylogeny[Rooted]"/>
35 </options>
36 <validator type="expression" message="Incompatible type">hasattr(value.metadata, "semantic_type") and value.metadata.semantic_type in ['Phylogeny[Rooted]']</validator>
37 </param>
38 <repeat name="metrics" help="[optional] The metrics to be measured. By default computes observed_features, shannon, and if phylogeny is provided, faith_pd." title="metrics: Set[Str % Choices('ace', 'berger_parker_d', 'brillouin_d', 'chao1', 'dominance', 'doubles', 'enspie', 'faith_pd', 'fisher_alpha', 'gini_index', 'goods_coverage', 'heip_e', 'lladser_pe', 'margalef', 'mcintosh_d', 'mcintosh_e', 'menhinick', 'michaelis_menten_fit', 'observed_features', 'pielou_e', 'robbins', 'shannon', 'simpson', 'simpson_e', 'singles')]">
39 <param name="element" type="select" label="element: Str % Choices('ace', 'berger_parker_d', 'brillouin_d', 'chao1', 'dominance', 'doubles', 'enspie', 'faith_pd', 'fisher_alpha', 'gini_index', 'goods_coverage', 'heip_e', 'lladser_pe', 'margalef', 'mcintosh_d', 'mcintosh_e', 'menhinick', 'michaelis_menten_fit', 'observed_features', 'pielou_e', 'robbins', 'shannon', 'simpson', 'simpson_e', 'singles')">
40 <option value="__q2galaxy__::literal::None">Selection required</option>
41 <option value="ace">ace</option>
42 <option value="berger_parker_d">berger_parker_d</option>
43 <option value="brillouin_d">brillouin_d</option>
44 <option value="chao1">chao1</option>
45 <option value="dominance">dominance</option>
46 <option value="doubles">doubles</option>
47 <option value="enspie">enspie</option>
48 <option value="faith_pd">faith_pd</option>
49 <option value="fisher_alpha">fisher_alpha</option>
50 <option value="gini_index">gini_index</option>
51 <option value="goods_coverage">goods_coverage</option>
52 <option value="heip_e">heip_e</option>
53 <option value="lladser_pe">lladser_pe</option>
54 <option value="margalef">margalef</option>
55 <option value="mcintosh_d">mcintosh_d</option>
56 <option value="mcintosh_e">mcintosh_e</option>
57 <option value="menhinick">menhinick</option>
58 <option value="michaelis_menten_fit">michaelis_menten_fit</option>
59 <option value="observed_features">observed_features</option>
60 <option value="pielou_e">pielou_e</option>
61 <option value="robbins">robbins</option>
62 <option value="shannon">shannon</option>
63 <option value="simpson">simpson</option>
64 <option value="simpson_e">simpson_e</option>
65 <option value="singles">singles</option>
66 <validator type="expression" message="Please verify this parameter.">value != '__q2galaxy__::literal::None'</validator>
67 </param>
68 </repeat>
69 <repeat name="metadata" help="[optional] The sample metadata." title="metadata: Metadata">
70 <conditional name="__q2galaxy__GUI__conditional__metadata__">
71 <param name="type" type="select" label="metadata: Metadata">
72 <option value="tsv" selected="true">Metadata from TSV</option>
73 <option value="qza">Metadata from Artifact</option>
74 </param>
75 <when value="tsv">
76 <param name="source" type="data" format="tabular,qiime2.tabular" label="Metadata Source"/>
77 </when>
78 <when value="qza">
79 <param name="source" type="data" format="qza" label="Metadata Source"/>
80 </when>
81 </conditional>
82 </repeat>
83 <param name="min_depth" type="integer" min="1" value="1" label="min_depth: Int % Range(1, None)" help="[default: 1] The minimum rarefaction depth."/>
84 <param name="steps" type="integer" min="2" value="10" label="steps: Int % Range(2, None)" help="[default: 10] The number of rarefaction depths to include between min_depth and max_depth."/>
85 <param name="iterations" type="integer" min="1" value="10" label="iterations: Int % Range(1, None)" help="[default: 10] The number of rarefied feature tables to compute at each step."/>
86 </section>
87 </inputs>
88 <outputs>
89 <data name="visualization" format="qzv" label="${tool.name} on ${on_string}: visualization.qzv" from_work_dir="visualization.qzv"/>
90 </outputs>
91 <tests/>
92 <help>
93 QIIME 2: diversity alpha-rarefaction
94 ====================================
95 Alpha rarefaction curves
96
97
98 Outputs:
99 --------
100 :visualization.qzv: &lt;no description&gt;
101
102 |
103
104 Description:
105 ------------
106 Generate interactive alpha rarefaction curves by computing rarefactions between `min_depth` and `max_depth`. The number of intermediate depths to compute is controlled by the `steps` parameter, with n `iterations` being computed at each rarefaction depth. If sample metadata is provided, samples may be grouped based on distinct values within a metadata column.
107
108
109 |
110
111 </help>
112 <citations>
113 <citation type="doi">10.1038/s41587-019-0209-9</citation>
114 </citations>
115 </tool>