Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API-v2 and python package changes #37

Open
wants to merge 1 commit into
base: gh-pages
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/_data/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
26 changes: 26 additions & 0 deletions docs/_docs/tutorials/api-v2.md
Original file line number Diff line number Diff line change
@@ -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)
39 changes: 39 additions & 0 deletions docs/_docs/tutorials/python-package.md
Original file line number Diff line number Diff line change
@@ -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)