showing suggestions for possible results for a search query using undocumented API request

[ayushanand18]

Overview

Many functions inside pyobis package demand the user to provide exact matches of scientificname, taxonid, or datasetid. While some researchers who are particularly interested in an individual record but many of the researchers who are starting up with their project may not know the exact id or scientific name to query for.

Notes

OBIS Mapper utilizes some endpoints to do the exact thing - suggest id or scientific name based on a query term.

• Here is a query for searching species with a keyword. Query looks like: https://api.obis.org/v3/taxon/complete/verbose/{search_term}
  

• Here is a query for searching datasets by name. Query looks like: https://api.obis.org/v3/dataset/complete/{search_term}
  

Questions

Should we include a function in occurrences module for searching a species via keyword like say a search_keyword(term="query-term-you'd-like-to-search-for")?

and a seperate function search_keyword(term="query-term-you'd-like-to-search-for") in dataset module for searching datasets by name?

[7yl4r]

This is an interesting proposal. Taking a moment to imagine how it could work:

pyobis.occurrence(taxonid=pyobis.lookup_taxon('fish'))

It definitely looks appealing, but I think further efforts on data visualization and analysis should take priority over this.

[ayushanand18]

Noted, thanks! We can jump on it later after we complete analysis notebooks.