Metadata-Version: 2.1
Name: panelapp
Version: 0.7.2
Summary: General purpose Panelapp package
Home-page: https://github.com/NHS-NGS/panelapp
Author: Yujin Kim
Author-email: yujin.kim@hotmail.fr
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown

# panelapp

Allows for lots of operations for Panelapp queries

## Install

``` python
pip install panelapp
```

## Import

``` python
from panelapp import Panelapp
from panelapp import api
from panelapp import queries
```

## How to use

``` python
from panelapp import Panelapp

panel = Panelapp.Panel(269)        # Create panel object, confidence level defaults to 3, version is the lastest
panel.get_info()                   # Return dict with general data about the panel
# For the 4 following methods you can specify the confidence levels
panel.get_genes()                  # Return all the gene symbols/ids
panel.get_gene_symbols()           # Return gene symbols according to confidence level choosen when creating the panel object
panel.get_hgnc_ids()               # Return hgnc ids according to confidence level choosen when creating the panel object
panel.get_ensembl_ids("GRCh37")    # Return ensembl ids according to confidence level choosen when creating the panel object
panel.update_version("3.2", "2")   # Update the panel with version and confidence level given
panel.is_signedoff()               # Return date of signedoff or False if not signedoff
panel.get_data()                   # Return all the data the API sent, you can use that there's something that is lacking in my methods
panel.write()                      # Write a file for the panel containing the most important data (according to me at least, you can customize this yourself using the .get_data() method)

from panelapp import queries

panels = queries.get_all_panels()                                         # Return dict {panel_id: Panelapp.Panel} of all panels in Panelapp
signedoff_panels = queries.get_all_signedoff_panels()                     # Return dict {panel_id: Panelapp.Panel} of signedoff panels
matches, differences = queries.compare_versions(Panelapp.Panel, "2.7")    # Return tuple of match and differences between the given panel and another panel version
panel = queries.get_signedoff_panel(269)                                  # Return panel object with latest signedoff version
```


