hubmapconsortium / search-api

HuBMAP search service and associated pieces to create an index
https://search.api.hubmapconsortium.org
MIT License
2 stars 2 forks source link

Documentation of Donor metadata and examples of how to query #866

Open shirey opened 2 months ago

shirey commented 2 months ago

Create a page of documentation explaining how Donor Metadata is stored using ontology terms/concepts including a separate page (maybe pages?) of reference for the various ontology pieces that we use from the Donor metadata valuesets spreadsheet for Race, Ethnicity, Age, Sex, Measurements, Cause of Death, Mechanism of Injury, Death Event, Blood Type, Medical History and Social History. (Need to include a Note/Warning that we mainly have Race, Ethnicity, Age and Sex information for Donors and other data is sparse.)

Also, create a Jupyter notebook with some example queries using both the /param-search and search endpoints. Link the Jupyter notebook from this new page of documentation. (Store the Jupyter notebook in GitHub at https://github.com/hubmapconsortium/search-api/tree/main/examples where other Jupyter search examples exist and link directly into GitHub.)