Fork me on GitHub

filter-table: Remove features from table if they’re not present in tree.

Docstring:

Usage: qiime phylogeny filter-table [OPTIONS]

  Remove features from a feature table if their identifiers are not tip
  identifiers in tree.

Inputs:
  --i-table ARTIFACT FeatureTable[Frequency]
                       Feature table that features should be filtered from.
                                                                    [required]
  --i-tree ARTIFACT Phylogeny[Rooted | Unrooted]
                       Tree where tip identifiers are the feature identifiers
                       that should be retained in the table.        [required]
Outputs:
  --o-filtered-table ARTIFACT FeatureTable[Frequency]
                       The resulting 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).
  --citations          Show citations and exit.
  --help               Show this message and exit.

Import:

from qiime2.plugins.phylogeny.methods import filter_table

Docstring:

Remove features from table if they're not present in tree.

Remove features from a feature table if their identifiers are not tip
identifiers in tree.

Parameters
----------
table : FeatureTable[Frequency]
    Feature table that features should be filtered from.
tree : Phylogeny[Rooted | Unrooted]
    Tree where tip identifiers are the feature identifiers that should be
    retained in the table.

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