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.

Options:
  --i-table ARTIFACT PATH FeatureTable[Frequency]
                                  Feature table that features should be
                                  filtered from.  [required]
  --i-tree ARTIFACT PATH Phylogeny[Rooted | Unrooted]
                                  Tree where tip identifiers are the feature
                                  identifiers that should be retained in the
                                  table.  [required]
  --o-filtered-table ARTIFACT PATH FeatureTable[Frequency]
                                  The resulting 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.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.