Mercurial > repos > q2d2 > qiime2__diversity_lib__bray_curtis
view qiime2__diversity_lib__bray_curtis.xml @ 5:84b38b24a50e draft default tip
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity_lib commit 5f71b597c9495eae67a447744fded834f56ca1f7
author | q2d2 |
---|---|
date | Wed, 30 Oct 2024 19:46:33 +0000 |
parents | 4111b5b17fd4 |
children |
line wrap: on
line source
<?xml version='1.0' encoding='utf-8'?> <!-- Copyright (c) 2024, QIIME 2 development team. Distributed under the terms of the Modified BSD License. (SPDX: BSD-3-Clause) --> <!-- This tool was automatically generated by: q2galaxy (version: 2024.10.0) for: qiime2 (version: 2024.10.1) --> <tool name="qiime2 diversity-lib bray-curtis" id="qiime2__diversity_lib__bray_curtis" version="2024.10.0+q2galaxy.2024.10.0" profile="22.05" license="BSD-3-Clause"> <description>Bray-Curtis Dissimilarity</description> <xrefs> <xref type="bio.tools">qiime2</xref> </xrefs> <requirements> <container type="docker">quay.io/qiime2/amplicon:2024.10</container> </requirements> <version_command>q2galaxy version diversity_lib</version_command> <command detect_errors="exit_code">q2galaxy run diversity_lib bray_curtis '$inputs'</command> <configfiles> <inputs name="inputs" data_style="staging_path_and_source_path"/> </configfiles> <inputs> <param name="table" type="data" format="qza" label="table: FeatureTable[Frequency | RelativeFrequency]" help="[required] The feature table containing the samples for which Bray-Curtis dissimilarity should be computed."> <options options_filter_attribute="metadata.semantic_type"> <filter type="add_value" value="FeatureTable[Frequency]"/> <filter type="add_value" value="FeatureTable[RelativeFrequency]"/> </options> <validator type="expression" message="Incompatible type">hasattr(value.metadata, "semantic_type") and value.metadata.semantic_type in ['FeatureTable[Frequency]', 'FeatureTable[RelativeFrequency]']</validator> </param> </inputs> <outputs> <data name="distance_matrix" format="qza" label="${tool.name} on ${on_string}: distance_matrix.qza" from_work_dir="distance_matrix.qza"/> </outputs> <tests> <test> <param name="table" value="bray_curtis.test0.feature-table.qza" ftype="qza"/> <output name="distance_matrix" ftype="qza"> <assert_contents> <has_archive_member path="[0-9a-f]{8}-[0-9a-f]{4}-[4][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}\/metadata.yaml"> <has_line_matching expression="type: DistanceMatrix"/> </has_archive_member> </assert_contents> </output> </test> <test> <param name="table" value="bray_curtis.test1.feature-table.qza" ftype="qza"/> <output name="distance_matrix" ftype="qza"> <assert_contents> <has_archive_member path="[0-9a-f]{8}-[0-9a-f]{4}-[4][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}\/metadata.yaml"> <has_line_matching expression="type: DistanceMatrix"/> </has_archive_member> </assert_contents> </output> </test> <test> <param name="table" value="bray_curtis.test2.feature-table.qza" ftype="qza"/> <output name="distance_matrix" ftype="qza"> <assert_contents> <has_archive_member path="[0-9a-f]{8}-[0-9a-f]{4}-[4][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}\/metadata.yaml"> <has_line_matching expression="type: DistanceMatrix"/> </has_archive_member> </assert_contents> </output> </test> </tests> <help> QIIME 2: diversity-lib bray-curtis ================================== Bray-Curtis Dissimilarity Outputs: -------- :distance_matrix.qza: Distance matrix for Bray-Curtis dissimilarity | Description: ------------ Compute Bray-Curtis dissimilarity for each sample in a feature table. Note: Frequency and relative frequency data produce different results unless overall sample sizes are identical. Please consider the impact on your results if you use Bray-Curtis with count data that has not been adjusted (normalized). Examples: --------- run on one core (by default) **************************** Using the ``qiime2 diversity-lib bray-curtis`` tool: #. Set *"table"* to ``#: feature-table.qza`` #. Press the ``Execute`` button. Once completed, for the new entry in your history, use the ``Edit`` button to set the name as follows: (Renaming is optional, but it will make any subsequent steps easier to complete.) .. list-table:: :align: left :header-rows: 1 * - History Name - *"Name"* to set (be sure to press ``Save``) * - ``#: qiime2 diversity-lib bray-curtis [...] : distance_matrix.qza`` - ``bray-curtis-dm.qza`` to run on n cores, replace 1 here with your preferred integer ************************************************************* Using the ``qiime2 diversity-lib bray-curtis`` tool: #. Set *"table"* to ``#: feature-table.qza`` #. Press the ``Execute`` button. Once completed, for the new entry in your history, use the ``Edit`` button to set the name as follows: (Renaming is optional, but it will make any subsequent steps easier to complete.) .. list-table:: :align: left :header-rows: 1 * - History Name - *"Name"* to set (be sure to press ``Save``) * - ``#: qiime2 diversity-lib bray-curtis [...] : distance_matrix.qza`` - ``bray-curtis-dm.qza`` use 'auto' to run on all of host system's available CPU cores ************************************************************* Using the ``qiime2 diversity-lib bray-curtis`` tool: #. Set *"table"* to ``#: feature-table.qza`` #. Press the ``Execute`` button. Once completed, for the new entry in your history, use the ``Edit`` button to set the name as follows: (Renaming is optional, but it will make any subsequent steps easier to complete.) .. list-table:: :align: left :header-rows: 1 * - History Name - *"Name"* to set (be sure to press ``Save``) * - ``#: qiime2 diversity-lib bray-curtis [...] : distance_matrix.qza`` - ``bray-curtis-dm.qza`` | </help> <citations> <citation type="bibtex">@article{cite1, author = {Sørensen, Thorvald}, journal = {Biol. Skr.}, pages = {1--34}, title = {A method of establishing groups of equal amplitude in plant sociology based on similarity of species and its application to analyses of the vegetation on Danish commons}, volume = {5}, year = {1948} } </citation> <citation type="doi">10.1038/s41587-019-0209-9</citation> </citations> </tool>