Docstring:
Usage: qiime feature-table merge [OPTIONS]
Combines feature tables using the `overlap_method` provided.
Inputs:
--i-tables ARTIFACTS... List[FeatureTable[Frequency]¹ |
FeatureTable[RelativeFrequency]² | FeatureTable[PresenceAbsence]³]
The collection of feature tables to be merged.
[required]
Parameters:
--p-overlap-method VALUE Str % Choices('average',
'error_on_overlapping_feature', 'error_on_overlapping_sample', 'sum')¹ |
Str % Choices('average', 'error_on_overlapping_feature',
'error_on_overlapping_sample')² | Str %
Choices('error_on_overlapping_feature', 'error_on_overlapping_sample',
'union')³ Method for handling overlapping ids.
[default: 'error_on_overlapping_sample']
Outputs:
--o-merged-table ARTIFACT FeatureTable[Frequency]¹ |
FeatureTable[RelativeFrequency]² | FeatureTable[PresenceAbsence]³
The resulting merged feature table. [required]
Miscellaneous:
--output-dir PATH Output unspecified results to a directory
--verbose / --quiet Display verbose output to stdout and/or stderr during
execution of this action. Or silence output if
execution is successful (silence is golden).
--example-data PATH Write example data and exit.
--citations Show citations and exit.
--help Show this message and exit.
Examples:
# ### example: feature table merge two tables
qiime feature-table merge \
--i-tables feature-table1.qza feature-table2.qza \
--o-merged-table merged-table.qza
# ### example: feature table merge three tables
qiime feature-table merge \
--i-tables feature-table1.qza feature-table2.qza feature-table3.qza \
--p-overlap-method sum \
--o-merged-table merged-table.qza
Import:
from qiime2.plugins.feature_table.methods import merge
Docstring:
Combine multiple tables
Combines feature tables using the `overlap_method` provided.
Parameters
----------
tables : List[FeatureTable[Frequency]¹ | FeatureTable[RelativeFrequency]² | FeatureTable[PresenceAbsence]³]
The collection of feature tables to be merged.
overlap_method : Str % Choices('average', 'error_on_overlapping_feature', 'error_on_overlapping_sample', 'sum')¹ | Str % Choices('average', 'error_on_overlapping_feature', 'error_on_overlapping_sample')² | Str % Choices('error_on_overlapping_feature', 'error_on_overlapping_sample', 'union')³, optional
Method for handling overlapping ids.
Returns
-------
merged_table : FeatureTable[Frequency]¹ | FeatureTable[RelativeFrequency]² | FeatureTable[PresenceAbsence]³
The resulting merged feature table.
