Fork me on GitHub

Warning

This site has been replaced by the new QIIME 2 “amplicon distribution” documentation, as of the 2025.4 release of QIIME 2. You can still access the content from the “old docs” here for the QIIME 2 2024.10 and earlier releases, but we recommend that you transition to the new documentation at https://amplicon-docs.qiime2.org. Content on this site is no longer updated and may be out of date.

Are you looking for:

Old content beyond this point… 👴👵

merge-taxa: Combine collections of feature taxonomies

Docstring:

Usage: qiime feature-table merge-taxa [OPTIONS]

  Combines a pair of feature data objects which may or may not contain data
  for the same features. If different feature data is present for the same
  feature id in the inputs, the data from the first will be propagated to the
  result.

Inputs:
  --i-data ARTIFACTS... List[FeatureData[Taxonomy]]
                         The collection of feature taxonomies to be merged.
                                                                    [required]
Outputs:
  --o-merged-data ARTIFACT FeatureData[Taxonomy]
                         The resulting collection of feature taxonomies
                         containing all feature taxonomies provided.
                                                                    [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.
  --use-cache DIRECTORY  Specify the cache to be used for the intermediate
                         work of this action. If not provided, the default
                         cache under $TMP/qiime2/ will be used.
                         IMPORTANT FOR HPC USERS: If you are on an HPC system
                         and are using parallel execution it is important to
                         set this to a location that is globally accessible to
                         all nodes in the cluster.
  --help                 Show this message and exit.

Examples:
  # ### example: feature table merge taxa
  qiime feature-table merge-taxa \
    --i-data tax1.qza tax2.qza \
    --o-merged-data merged-data.qza

Import:

from qiime2.plugins.feature_table.methods import merge_taxa

Docstring:

Combine collections of feature taxonomies

Combines a pair of feature data objects which may or may not contain data
for the same features. If different feature data is present for the same
feature id in the inputs, the data from the first will be propagated to the
result.

Parameters
----------
data : List[FeatureData[Taxonomy]]
    The collection of feature taxonomies to be merged.

Returns
-------
merged_data : FeatureData[Taxonomy]
    The resulting collection of feature taxonomies containing all feature
    taxonomies provided.