`lmpy.data_wrangling.tree.subset_tree_wrangler`

Module containing data wranglers for subsetting a tree.

Module Contents

Classes

SubsetTreeWrangler

Constructor for SubsetTreeWrangler class.

class lmpy.data_wrangling.tree.subset_tree_wrangler.SubsetTreeWrangler(keep_taxa, **params)[source]

Bases: lmpy.data_wrangling.tree.base._TreeDataWrangler

Constructor for SubsetTreeWrangler class.

Parameters

keep_taxa (list of str) – A list of taxon names to keep.
**params (dict) – Keyword parameters to pass to _MatrixDataWrangler.

name = SubsetTreeWrangler[source]

version = 1.0[source]

wrangle_tree(self, tree)[source]

Wrangle a tree.

Parameters: tree (TreeWrapper) – A tree to wrangle.
Returns: The subsetted tree.
Return type: TreeWrapper