lmpy.data_wrangling.tree.match_matrix_wrangler

Module containing data wranglers for subsetting a tree to match a matrix.

Module Contents

Classes

MatchMatrixTreeWrangler

Constructor for SubsetTreeWrangler class.

class lmpy.data_wrangling.tree.match_matrix_wrangler.MatchMatrixTreeWrangler(matrix, species_axis, **params)

Bases: lmpy.data_wrangling.tree.base._TreeDataWrangler

Constructor for SubsetTreeWrangler class.

Parameters

• matrix (Matrix) – A matrix to get taxon names to match.

• species_axis (int) – The matrix axis with taxon names.

• **params (dict) – Keyword parameters to pass to _MatrixDataWrangler.

name = MatchMatrixTreeWrangler

version = 1.0

wrangle_tree(tree)

Wrangle a tree.

Parameters

tree (TreeWrapper) – A tree to wrangle.

Returns

The subsetted tree.

Return type

TreeWrapper