Fork me on GitHub

merge: Combine multiple tablesΒΆ

Docstring:

Usage: qiime feature-table merge [OPTIONS]

  Combines feature tables using the `overlap_method` provided.

Options:
  --i-tables MULTIPLE ARTIFACT PATH List[FeatureTable[Frequency]]
                                  The collection of feature tables to be
                                  merged.  [required]
  --p-overlap-method [sum|error_on_overlapping_feature|error_on_overlapping_sample]
                                  Method for handling overlapping ids.
                                  [default: error_on_overlapping_sample]
  --o-merged-table ARTIFACT PATH FeatureTable[Frequency]
                                  The resulting merged feature table.
                                  [required if not passing --output-dir]
  --output-dir DIRECTORY          Output unspecified results to a directory
  --cmd-config FILE               Use config file for command options
  --verbose                       Display verbose output to stdout and/or
                                  stderr during execution of this action.
                                  [default: False]
  --quiet                         Silence output if execution is successful
                                  (silence is golden).  [default: False]
  --citations                     Show citations and exit.
  --help                          Show this message and exit.

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]]
    The collection of feature tables to be merged.
overlap_method : Str % Choices({'error_on_overlapping_feature', 'error_on_overlapping_sample', 'sum'}), optional
    Method for handling overlapping ids.

Returns
-------
merged_table : FeatureTable[Frequency]
    The resulting merged feature table.