From 514161681cd4afb7406cfd3971a6443107aaeb56 Mon Sep 17 00:00:00 2001 From: akshala Date: Fri, 12 Apr 2024 20:36:09 -0700 Subject: [PATCH] API-v2 and python package changes --- docs/_data/toc.yml | 4 +++ docs/_docs/tutorials/api-v2.md | 26 +++++++++++++++++ docs/_docs/tutorials/python-package.md | 39 ++++++++++++++++++++++++++ 3 files changed, 69 insertions(+) create mode 100644 docs/_docs/tutorials/api-v2.md create mode 100644 docs/_docs/tutorials/python-package.md diff --git a/docs/_data/toc.yml b/docs/_data/toc.yml index cac9463..19d928b 100644 --- a/docs/_data/toc.yml +++ b/docs/_data/toc.yml @@ -13,8 +13,12 @@ url: "docs/tutorials/ui-query" - title: Using AnnoQ API url: "docs/tutorials/api" + - title: Using AnnoQ API v2 + url: "docs/tutorials/api-v2" - title: Using AnnoQR (R Package) url: "docs/tutorials/r-package" + - title: Using Annoq-py (Python Package) + url: "docs/tutorials/python-package" - title: "Changelog" url: "docs/changelog/features" links: diff --git a/docs/_docs/tutorials/api-v2.md b/docs/_docs/tutorials/api-v2.md new file mode 100644 index 0000000..d383188 --- /dev/null +++ b/docs/_docs/tutorials/api-v2.md @@ -0,0 +1,26 @@ +--- +--- + +# AnnoQ API-v2 +Currently Annoq API v2 is live at http://annoq.org/api-v2/. + +## Examples +[Here](https://github.com/USCbiostats/annoq-api-v2/blob/master/demo/usage.ipynb) are some examples of how to use the graphql endpoint of the API. + +## Annotation tree structure +* endpoint +`/annotations` - Returns a json with the annotation tree + +## Download request +* endpoint +`/download/{folder}/{name}` - Downloads a text file using the download path returned in the download graphql query. + +## All other queries +* endpoint +`/graphql` + + +**What's Next** + +- [Interactive Query UI Tutorial]({{site.baseurl}}/docs/tutorials/ui-query) +- [Python package (Annoq-py) Tutorial]({{site.baseurl}}/docs/tutorials/python-package) \ No newline at end of file diff --git a/docs/_docs/tutorials/python-package.md b/docs/_docs/tutorials/python-package.md new file mode 100644 index 0000000..8f8c448 --- /dev/null +++ b/docs/_docs/tutorials/python-package.md @@ -0,0 +1,39 @@ +--- +--- +# AnnoQR (R Package) + +[GitHub Repo](https://github.com/USCbiostats/annoq-py) + +## Introduction + +This is a python client for performing queries with AnnoQ API-v2. + +## Installation + +Install from [GitHub Repo](https://github.com/USCbiostats/annoq-py) + +Clone the repo and then use then following command + +``` +pip install . +``` + +## Function List +* GetSNPsByChromosome +* GetSNPsByGeneProduct +* GetSNPsByIDs +* GetSNPsByRsID +* GetSNPsByRsIDs +* CountSNPsByChromosome +* CountSNPsByGeneProduct +* CountSNPsByIDs +* CountSNPsByRsID +* CountSNPsByRsID + +## Examples +[Here](https://github.com/USCbiostats/annoq-py) are some examples of how to use the python package. + +**Whats Next** + +- [Interactive Query UI Tutorial]({{site.baseurl}}/docs/tutorials/ui-query) +- [API-v2 Documentation Tutorial]({{site.baseurl}}/docs/tutorials/api-v2) \ No newline at end of file