lmpy.data_wrangling.species_list.match_matrix_wrangler

Module containing data wranglers for subsetting a species list to match a matrix.

Module Contents

Classes

MatchMatrixSpeciesListWrangler

Constructor for MatchMatrixSpeciesListWrangler class.

class lmpy.data_wrangling.species_list.match_matrix_wrangler.MatchMatrixSpeciesListWrangler(matrix, species_axis, **params)

Bases: lmpy.data_wrangling.species_list.base._SpeciesListDataWrangler

Constructor for MatchMatrixSpeciesListWrangler 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 _SpeciesListDataWrangler.

name = MatchMatrixSpeciesListWrangler

version = 1.0

wrangle_species_list(species_list)

Wrangle a species list.

Parameters

species_list (SpeciesList) – A species list to wrangle.

Returns

A species list intersected with the provided matrix.

Return type

SpeciesList