Open ayushanand18 opened 2 years ago
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.
Noted, thanks! We can jump on it later after we complete analysis notebooks.
Overview
Many functions inside
pyobis
package demand the user to provide exact matches ofscientificname
,taxonid
, ordatasetid
. 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}![image](https://user-images.githubusercontent.com/36472216/183248988-66f69989-b989-4fc6-a595-a8a2e4122e0e.png)
Here is a query for searching datasets by name. Query looks like: https://api.obis.org/v3/dataset/complete/{search_term}![image](https://user-images.githubusercontent.com/36472216/183249003-80e3f161-c7db-461e-8c58-786774791e52.png)
Questions
Should we include a function in
occurrences
module for searching a species via keyword like say asearch_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")
indataset
module for searching datasets by name?