lmpy.data_wrangling.species_list.accepted_name_wrangler

Module containing occurrence data wranglers for modifying a species list.

Module Contents

Classes

AcceptedNameSpeciesListWrangler

Constructor for AcceptedNameSpeciesListModifier class.
class lmpy.data_wrangling.species_list.accepted_name_wrangler.AcceptedNameSpeciesListWrangler(name_map=None, name_resolver=None, purge_failures=True, out_map_filename=None, map_write_interval=100, out_map_format='json', **params)[source]

Bases: lmpy.data_wrangling.species_list.base._SpeciesListDataWrangler, lmpy.data_wrangling.common.accepted_name_wrangler._AcceptedNameWrangler

Constructor for AcceptedNameSpeciesListModifier class.

Parameters

  • name_map (dict) – A map of original name to accepted name.

  • name_resolver (str or Method) – If provided, use this method for getting new accepted names. If set to ‘gbif’, use GBIF name resolution.

  • purge_failures (bool) – Should failures be purged from the tree.

  • out_map_filename (str) – A file location to write the updated name map.

  • map_write_interval (int) – Update the name map output file after each set of this many iterations.

  • out_map_format (str) – The format to write the names map (csv or json).

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

name = AcceptedNameSpeciesListWrangler[source]
version = 1.0[source]
wrangle_species_list(species_list)[source]

Wrangle a species list.

Parameters

species_list (SpeciesList) – A species list to wrangle.

Returns

A species list with accepted names.

Return type

SpeciesList