# HG changeset patch # User q2d2 # Date 1661802291 0 # Node ID faf299216a5eb52fca0850d536034adf12e8e7cc planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity_lib commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1 diff -r 000000000000 -r faf299216a5e qiime2__diversity_lib__beta_phylogenetic_passthrough.xml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/qiime2__diversity_lib__beta_phylogenetic_passthrough.xml Mon Aug 29 19:44:51 2022 +0000 @@ -0,0 +1,376 @@ + + + + + Beta Phylogenetic Passthrough + + quay.io/qiime2/core:2022.8 + + q2galaxy version diversity_lib + q2galaxy run diversity_lib beta_phylogenetic_passthrough '$inputs' + + + + + + + + + hasattr(value.metadata, "semantic_type") and value.metadata.semantic_type in ['FeatureTable[Frequency]'] + + + + + + hasattr(value.metadata, "semantic_type") and value.metadata.semantic_type in ['Phylogeny[Rooted]'] + + + + + + + + value != '__q2galaxy__::literal::None' + +
+ + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +QIIME 2: diversity-lib beta-phylogenetic-passthrough +==================================================== +Beta Phylogenetic Passthrough + + +Outputs: +-------- +:distance_matrix.qza: The resulting distance matrix. + +| + +Description: +------------ +Computes a distance matrix for all pairs of samples in a feature table using the unifrac implementation of the selected beta diversity metric. + +Examples: +--------- + +run on one core (by default) +**************************** +Using the ``qiime2 diversity-lib beta-phylogenetic-passthrough`` tool: + #. Set *"table"* to ``#: feature-table.qza`` + #. Set *"phylogeny"* to ``#: phylogeny.qza`` + #. Set *"metric"* to ``weighted_normalized_unifrac`` + #. 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 beta-phylogenetic-passthrough [...] : distance_matrix.qza`` + - ``weighted-normalized-unifrac-dm.qza`` + +to run on n cores, replace 1 here with your preferred integer +************************************************************* +Using the ``qiime2 diversity-lib beta-phylogenetic-passthrough`` tool: + #. Set *"table"* to ``#: feature-table.qza`` + #. Set *"phylogeny"* to ``#: phylogeny.qza`` + #. Set *"metric"* to ``weighted_normalized_unifrac`` + #. Expand the ``additional options`` section + + - Leave *"threads"* as its default value of ``1`` + + #. 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 beta-phylogenetic-passthrough [...] : distance_matrix.qza`` + - ``weighted-normalized-unifrac-dm.qza`` + +use 'auto' to run on all of host system's available CPU cores +************************************************************* +Using the ``qiime2 diversity-lib beta-phylogenetic-passthrough`` tool: + #. Set *"table"* to ``#: feature-table.qza`` + #. Set *"phylogeny"* to ``#: phylogeny.qza`` + #. Set *"metric"* to ``weighted_normalized_unifrac`` + #. Expand the ``additional options`` section + + - Set *"threads"* to ``auto`` + + #. 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 beta-phylogenetic-passthrough [...] : distance_matrix.qza`` + - ``weighted-normalized-unifrac-dm.qza`` + +use bypass_tips to trade specificity for reduced compute time +************************************************************* +| bypass_tips can be used with any threads setting, but auto may be a good choice if you're trimming run time. +Using the ``qiime2 diversity-lib beta-phylogenetic-passthrough`` tool: + #. Set *"table"* to ``#: feature-table.qza`` + #. Set *"phylogeny"* to ``#: phylogeny.qza`` + #. Set *"metric"* to ``weighted_normalized_unifrac`` + #. Expand the ``additional options`` section + + #. Set *"threads"* to ``auto`` + #. Set *"bypass_tips"* to ``Yes`` + + #. 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 beta-phylogenetic-passthrough [...] : distance_matrix.qza`` + - ``weighted-normalized-unifrac-dm.qza`` + +variance adjustment +******************* +| Chang et al's variance adjustment may be applied to any unifrac method by using this passthrough function. +Using the ``qiime2 diversity-lib beta-phylogenetic-passthrough`` tool: + #. Set *"table"* to ``#: feature-table.qza`` + #. Set *"phylogeny"* to ``#: phylogeny.qza`` + #. Set *"metric"* to ``weighted_unifrac`` + #. Expand the ``additional options`` section + + #. Set *"threads"* to ``auto`` + #. Set *"variance_adjusted"* to ``Yes`` + + #. 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 beta-phylogenetic-passthrough [...] : distance_matrix.qza`` + - ``var-adj-weighted-unifrac-dm.qza`` + +minimal generalized unifrac +*************************** +| Generalized unifrac is passed alpha=1 by default. This is roughly equivalent to weighted normalized unifrac, which method will be used instead, because it is better optimized. +Using the ``qiime2 diversity-lib beta-phylogenetic-passthrough`` tool: + #. Set *"table"* to ``#: feature-table.qza`` + #. Set *"phylogeny"* to ``#: phylogeny.qza`` + #. Set *"metric"* to ``generalized_unifrac`` + #. 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 beta-phylogenetic-passthrough [...] : distance_matrix.qza`` + - ``generalized-unifrac-dm.qza`` + +generalized unifrac +******************* +| passing a float between 0 and 1 to 'alpha' gives you control over the importance of sample proportions. +Using the ``qiime2 diversity-lib beta-phylogenetic-passthrough`` tool: + #. Set *"table"* to ``#: feature-table.qza`` + #. Set *"phylogeny"* to ``#: phylogeny.qza`` + #. Set *"metric"* to ``generalized_unifrac`` + #. Expand the ``additional options`` section + + - Set *"alpha"* to ``0.75`` + + #. 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 beta-phylogenetic-passthrough [...] : distance_matrix.qza`` + - ``generalized-unifrac-dm.qza`` + + +| + + + + 10.1128/AEM.71.12.8228-8235.2005 + 10.1128/AEM.01996-06 + 10.1038/ismej.2009.97 + 10.1038/ismej.2010.133 + 10.1038/s41592-018-0187-8 + 10.1186/1471-2105-12-118 + 10.1093/bioinformatics/bts342 + @article{cite8, + author = {Sfiligoi, Igor and Armstrong, George and Gonzalez, Antonio and McDonald, Daniel and Knight, Rob}, + journal = {mSystems}, + title = {Optimizing UniFrac with OpenACC yields >1000x speed increase}, + year = {in press} +} + + 10.1038/s41587-019-0209-9 + +
diff -r 000000000000 -r faf299216a5e test-data/alpha_passthrough.test0.feature-table.qza Binary file test-data/alpha_passthrough.test0.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_passthrough.test0.feature-table.qza Binary file test-data/beta_passthrough.test0.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_passthrough.test1.feature-table.qza Binary file test-data/beta_passthrough.test1.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_passthrough.test2.feature-table.qza Binary file test-data/beta_passthrough.test2.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_passthrough.test3.feature-table.qza Binary file test-data/beta_passthrough.test3.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_meta_passthrough.test0.feature-table1.qza Binary file test-data/beta_phylogenetic_meta_passthrough.test0.feature-table1.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_meta_passthrough.test0.feature-table2.qza Binary file test-data/beta_phylogenetic_meta_passthrough.test0.feature-table2.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_meta_passthrough.test0.phylogeny1.qza Binary file test-data/beta_phylogenetic_meta_passthrough.test0.phylogeny1.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_meta_passthrough.test0.phylogeny2.qza Binary file test-data/beta_phylogenetic_meta_passthrough.test0.phylogeny2.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_meta_passthrough.test1.feature-table1.qza Binary file test-data/beta_phylogenetic_meta_passthrough.test1.feature-table1.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_meta_passthrough.test1.feature-table2.qza Binary file test-data/beta_phylogenetic_meta_passthrough.test1.feature-table2.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_meta_passthrough.test1.phylogeny.qza Binary file test-data/beta_phylogenetic_meta_passthrough.test1.phylogeny.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_meta_passthrough.test2.feature-table1.qza Binary file test-data/beta_phylogenetic_meta_passthrough.test2.feature-table1.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_meta_passthrough.test2.feature-table2.qza Binary file test-data/beta_phylogenetic_meta_passthrough.test2.feature-table2.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_meta_passthrough.test2.phylogeny1.qza Binary file test-data/beta_phylogenetic_meta_passthrough.test2.phylogeny1.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_meta_passthrough.test2.phylogeny2.qza Binary file test-data/beta_phylogenetic_meta_passthrough.test2.phylogeny2.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_passthrough.test0.feature-table.qza Binary file test-data/beta_phylogenetic_passthrough.test0.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_passthrough.test0.phylogeny.qza Binary file test-data/beta_phylogenetic_passthrough.test0.phylogeny.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_passthrough.test1.feature-table.qza Binary file test-data/beta_phylogenetic_passthrough.test1.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_passthrough.test1.phylogeny.qza Binary file test-data/beta_phylogenetic_passthrough.test1.phylogeny.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_passthrough.test2.feature-table.qza Binary file test-data/beta_phylogenetic_passthrough.test2.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_passthrough.test2.phylogeny.qza Binary file test-data/beta_phylogenetic_passthrough.test2.phylogeny.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_passthrough.test3.feature-table.qza Binary file test-data/beta_phylogenetic_passthrough.test3.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_passthrough.test3.phylogeny.qza Binary file test-data/beta_phylogenetic_passthrough.test3.phylogeny.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_passthrough.test4.feature-table.qza Binary file test-data/beta_phylogenetic_passthrough.test4.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_passthrough.test4.phylogeny.qza Binary file test-data/beta_phylogenetic_passthrough.test4.phylogeny.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_passthrough.test5.feature-table.qza Binary file test-data/beta_phylogenetic_passthrough.test5.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_passthrough.test5.phylogeny.qza Binary file test-data/beta_phylogenetic_passthrough.test5.phylogeny.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_passthrough.test6.feature-table.qza Binary file test-data/beta_phylogenetic_passthrough.test6.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/beta_phylogenetic_passthrough.test6.phylogeny.qza Binary file test-data/beta_phylogenetic_passthrough.test6.phylogeny.qza has changed diff -r 000000000000 -r faf299216a5e test-data/bray_curtis.test0.feature-table.qza Binary file test-data/bray_curtis.test0.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/bray_curtis.test1.feature-table.qza Binary file test-data/bray_curtis.test1.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/bray_curtis.test2.feature-table.qza Binary file test-data/bray_curtis.test2.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/faith_pd.test0.feature-table.qza Binary file test-data/faith_pd.test0.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/faith_pd.test0.phylogeny.qza Binary file test-data/faith_pd.test0.phylogeny.qza has changed diff -r 000000000000 -r faf299216a5e test-data/jaccard.test0.feature-table.qza Binary file test-data/jaccard.test0.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/jaccard.test1.feature-table.qza Binary file test-data/jaccard.test1.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/jaccard.test2.feature-table.qza Binary file test-data/jaccard.test2.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/observed_features.test0.feature-table.qza Binary file test-data/observed_features.test0.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/pielou_evenness.test0.feature-table.qza Binary file test-data/pielou_evenness.test0.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/pielou_evenness.test1.feature-table.qza Binary file test-data/pielou_evenness.test1.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/shannon_entropy.test0.feature-table.qza Binary file test-data/shannon_entropy.test0.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/shannon_entropy.test1.feature-table.qza Binary file test-data/shannon_entropy.test1.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/unweighted_unifrac.test0.feature-table.qza Binary file test-data/unweighted_unifrac.test0.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/unweighted_unifrac.test0.phylogeny.qza Binary file test-data/unweighted_unifrac.test0.phylogeny.qza has changed diff -r 000000000000 -r faf299216a5e test-data/unweighted_unifrac.test1.feature-table.qza Binary file test-data/unweighted_unifrac.test1.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/unweighted_unifrac.test1.phylogeny.qza Binary file test-data/unweighted_unifrac.test1.phylogeny.qza has changed diff -r 000000000000 -r faf299216a5e test-data/unweighted_unifrac.test2.feature-table.qza Binary file test-data/unweighted_unifrac.test2.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/unweighted_unifrac.test2.phylogeny.qza Binary file test-data/unweighted_unifrac.test2.phylogeny.qza has changed diff -r 000000000000 -r faf299216a5e test-data/unweighted_unifrac.test3.feature-table.qza Binary file test-data/unweighted_unifrac.test3.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/unweighted_unifrac.test3.phylogeny.qza Binary file test-data/unweighted_unifrac.test3.phylogeny.qza has changed diff -r 000000000000 -r faf299216a5e test-data/weighted_unifrac.test0.feature-table.qza Binary file test-data/weighted_unifrac.test0.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/weighted_unifrac.test0.phylogeny.qza Binary file test-data/weighted_unifrac.test0.phylogeny.qza has changed diff -r 000000000000 -r faf299216a5e test-data/weighted_unifrac.test1.feature-table.qza Binary file test-data/weighted_unifrac.test1.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/weighted_unifrac.test1.phylogeny.qza Binary file test-data/weighted_unifrac.test1.phylogeny.qza has changed diff -r 000000000000 -r faf299216a5e test-data/weighted_unifrac.test2.feature-table.qza Binary file test-data/weighted_unifrac.test2.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/weighted_unifrac.test2.phylogeny.qza Binary file test-data/weighted_unifrac.test2.phylogeny.qza has changed diff -r 000000000000 -r faf299216a5e test-data/weighted_unifrac.test3.feature-table.qza Binary file test-data/weighted_unifrac.test3.feature-table.qza has changed diff -r 000000000000 -r faf299216a5e test-data/weighted_unifrac.test3.phylogeny.qza Binary file test-data/weighted_unifrac.test3.phylogeny.qza has changed