aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHao Chen2019-05-09 00:06:48 -0500
committerHao Chen2019-05-09 00:06:48 -0500
commit502008d20887f69557e223129e2f520d51272c2a (patch)
tree3debb06d9b0212bedb95752bf39166676cb3a674
parent2fe62381ba9e0bda51205d708c62e36435c60ea7 (diff)
downloadgenecup-502008d20887f69557e223129e2f520d51272c2a.tar.gz
update readme
-rw-r--r--Readme.md18
1 files changed, 16 insertions, 2 deletions
diff --git a/Readme.md b/Readme.md
index 44624c1..4a82b73 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,3 +1,17 @@
-# GatPub: Gene addictionness through PubMed
+# RatsPub: Relationship with Addiction Through Searches of PubMed
-This is an app that searches PubMed to find sentences that describe potential roles of genes in drug addiction.
+This app searches PubMed to find sentences that contain the query terms (e.g., gene symbols) and a drug addiction related keyword. These keywords belong to the following categories:
+* names of abused drugs, e.g., opioids
+* terms describing addiction, e.g., relapse
+* key brain regions implicated in addiction, e.g., ventral striatum
+* neurotrasmission, e.g., dopaminergic
+* synaptic plasticity, e.g., long term potentiation
+* intracellular signaling, e.g., phosphorylation
+
+Live searches are conducted through PubMed to get relevant PMIDs, which are then used to retrieve the abstracts from a local archive. The relationships are presented as an interactive cytoscape graph. The nodes can be moved around to better reveal the connections. Clicking on the links will bring up the corresponding sentences in a new browser window.
+
+## dependencies
+
+* [local copy of PubMed](https://dataguide.nlm.nih.gov/edirect/archive.html)
+* python flask
+* cytoscape.js