annotate qiime2__stats__wilcoxon_srt_facet.xml @ 0:181c3cf66bd8 draft default tip

planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
author q2d2
date Wed, 30 Oct 2024 19:57:48 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
1 <?xml version='1.0' encoding='utf-8'?>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
2 <!--
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
3 Copyright (c) 2024, QIIME 2 development team.
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
4
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
5 Distributed under the terms of the Modified BSD License. (SPDX: BSD-3-Clause)
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
6 -->
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
7 <!--
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
8 This tool was automatically generated by:
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
9 q2galaxy (version: 2024.10.0)
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
10 for:
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
11 qiime2 (version: 2024.10.1)
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
12 -->
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
13 <tool name="qiime2 stats wilcoxon-srt-facet" id="qiime2__stats__wilcoxon_srt_facet" version="0+unknown-q2galaxy.2024.10.0" profile="22.05" license="BSD-3-Clause">
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
14 <description>Per-facet Wilcoxon Signed Rank Test</description>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
15 <xrefs>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
16 <xref type="bio.tools">qiime2</xref>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
17 </xrefs>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
18 <requirements>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
19 <container type="docker">quay.io/qiime2/amplicon:2024.10</container>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
20 </requirements>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
21 <version_command>q2galaxy version stats</version_command>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
22 <command detect_errors="exit_code">q2galaxy run stats wilcoxon_srt_facet '$inputs'</command>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
23 <configfiles>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
24 <inputs name="inputs" data_style="staging_path_and_source_path"/>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
25 </configfiles>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
26 <inputs>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
27 <param name="distribution" type="data" format="qza" label="distribution: Dist1D[Multi | NestedOrdered | NestedUnordered, Matched]" help="[required]">
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
28 <options options_filter_attribute="metadata.semantic_type">
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
29 <filter type="add_value" value="Dist1D[NestedUnordered, Matched]"/>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
30 <filter type="add_value" value="Dist1D[NestedOrdered, Matched]"/>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
31 <filter type="add_value" value="Dist1D[Multi, Matched]"/>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
32 </options>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
33 <validator type="expression" message="Incompatible type">hasattr(value.metadata, "semantic_type") and value.metadata.semantic_type in ['Dist1D[Multi, Matched]', 'Dist1D[NestedOrdered, Matched]', 'Dist1D[NestedUnordered, Matched]']</validator>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
34 </param>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
35 <section name="__q2galaxy__GUI__section__extra_opts__" title="Click here for additional options">
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
36 <param name="ignore_empty_comparator" type="boolean" truevalue="__q2galaxy__::literal::True" falsevalue="__q2galaxy__::literal::False" checked="true" label="ignore_empty_comparator: Bool" help="[default: Yes] Ignore any group that does not have any overlapping subjects with comparison group. These groups will have NaNs in the stats table output"/>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
37 </section>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
38 </inputs>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
39 <outputs>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
40 <data name="stats" format="qza" label="${tool.name} on ${on_string}: stats.qza" from_work_dir="stats.qza"/>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
41 </outputs>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
42 <tests>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
43 <test>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
44 <param name="distribution" value="wilcoxon_srt_facet.test0.dist.qza" ftype="qza"/>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
45 <output name="stats" ftype="qza"/>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
46 </test>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
47 </tests>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
48 <help>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
49 QIIME 2: stats wilcoxon-srt-facet
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
50 =================================
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
51 Per-facet Wilcoxon Signed Rank Test
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
52
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
53
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
54 Outputs:
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
55 --------
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
56 :stats.qza: &lt;no description&gt;
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
57
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
58 |
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
59
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
60 Description:
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
61 ------------
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
62
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
63
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
64 Examples:
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
65 ---------
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
66
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
67 wilcoxon_srt_facet
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
68 ******************
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
69 Using the ``qiime2 stats wilcoxon-srt-facet`` tool:
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
70 #. Set *"distribution"* to ``#: dist.qza``
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
71 #. Press the ``Execute`` button.
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
72
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
73
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
74
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
75 |
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
76
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
77 </help>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
78 <citations>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
79 <citation type="doi">https://doi.org/10.2307/3001968</citation>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
80 <citation type="doi">10.1038/s41587-019-0209-9</citation>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
81 </citations>
181c3cf66bd8 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__stats commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents:
diff changeset
82 </tool>