regi0.taxonomic.speciesplus

regi0.taxonomic.speciesplus.get_distributions(ids: Union[float, int, list, pandas.Series, str], token: str, language: str = 'EN', add_supplied_ids: bool = False, expand: bool = True) → pandas.DataFrame

Get species distributions (i.e. country occurrences) for multiple taxon concept IDs.

Parameters

  • ids (float, int, list, pd.Series, str) – Taxon concept ID(s) to get results for. A convenient way of retrieving these IDs for one or multiple scientific names is using the get_taxon_concept function, which returns an id column.

  • token (Species+/CITES checklist API authentication token.) – Species+/CITES checklist API authentication token.

  • language (str) – Language for the names of distributions. Can be “EN”, “ES” or “FR”.

  • add_supplied_ids (bool) – Add supplied taxon_concept_ids to the resulting DataFrame.

  • expand (bool) – Whether to expand result rows to match names size. If False, the number of rows will correspond to the number of unique names in names.

Returns

DataFrame with distributions information.

Return type

DataFrame

regi0.taxonomic.speciesplus.get_references(ids: Union[float, int, list, pandas.Series, str], token: str, add_supplied_ids: bool = False, expand: bool = True) → pandas.DataFrame

Get references for multiple taxon concept IDs.

Parameters

  • ids (float, int, list, pd.Series, str) – Taxon concept ID(s) to get results for. A convenient way of retrieving these IDs for one or multiple scientific names is using the get_taxon_concept function, which returns an id column.

  • token (Species+/CITES checklist API authentication token.) – Species+/CITES checklist API authentication token.

  • add_supplied_ids (bool) – Add supplied taxon_concept_ids to the resulting DataFrame.

  • expand (bool) – Whether to expand result rows to match names size. If False, the number of rows will correspond to the number of unique names in names.

Returns

DataFrame with references information.

Return type

DataFrame

regi0.taxonomic.speciesplus.get_taxon_concept(names: Union[list, pandas.Series, str], token: str, language: Union[str, list] = 'EN', add_supplied_names: bool = False, expand: bool = True) → pandas.DataFrame

Get the most recent taxon concept for multiple scientific names using the taxon_concepts endpoint of the Species+/CITES checklist API.

Parameters

  • names (list, Series or str) – Scientific name(s) to get results for.

  • token (str) – Species+/CITES checklist API authentication token.

  • language (str or list) – One or multiple ISO 639-1 codes (codes for the representation of names of languages; e.g. EN or ES) used to filter languages returned for common names.

  • add_supplied_names (bool) – Add supplied scientific names to the resulting DataFrame.

  • expand (bool) – Whether to expand result rows to match names size. If False, the number of rows will correspond to the number of unique names in names.

Returns

DataFrame with taxon concept information.

Return type

DataFrame