Skip to content
This repository has been archived by the owner on Apr 12, 2023. It is now read-only.

better document /jupyter notebooks/drug_response_predict.ipynb #137

Open
andrewsu opened this issue Dec 9, 2020 · 0 comments
Open

better document /jupyter notebooks/drug_response_predict.ipynb #137

andrewsu opened this issue Dec 9, 2020 · 0 comments

Comments

@andrewsu
Copy link
Member

andrewsu commented Dec 9, 2020

We have a very nice notebook that demonstrates annotating nodes and edges in BTE queries, and using those annotations to filter and/or rank. https://github.com/biothings/biothings_explorer/blob/master/jupyter%20notebooks/drug_response_predict.ipynb

To make it easier to digest for new users, let's add some additional documentation. For example, the notebook currently contains this information in a markdown cell:

For the first step of the query (Disease - Gene), we specify to use a Normalized Google Distance (NGD) filter which only return associations with NGD score less than 0.6.
For the second step of the query (Gene - Chemical), we specify to filter for association only under the context of Breast Cancer and limit the predicate to gene_has_variant_that_contributes_to_drug_response.
Finally, we ask the results to be annotated with drugPhase, nodeDegree and survivalProbability information.

It would be good to explain where the NGD, association data, drugPhase, nodeDegre, and survivalProbability information come from, since these are not simple queries on the SmartAPI meta-kg.

similarly, in df2 = pd.display_table_view(extra_fields=["drug_phase", "survival_prob_change", "ngd"]), it would be good to explain what the extra_fields parameter is doing.

There are probably additional opportunities to better clarify in the inline documentation what is happening and the intent of the operations.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant