Skip to main content

No project description provided

Project description

IPR

build PyPi codecov PyPI - Downloads DOI

This repository is part of the Platform for Oncogenomic Reporting and Interpretation (PORI).

This python tool takes in variant inputs as tab-delimited files and annotates them using GraphKB. The resulting output is uploaded to IPR as a report. Additional report content such as images and metadata can be passed to be included in the report upload.

For documentation on how to create reports using this adaptor, see the main documentation site for the platform.

Getting Started

Install (For developers)

clone this repository

git clone https://github.com/bcgsc/pori_ipr_python.git
cd pori_ipr_python

create a virtual environment

python3 -m venv venv
source venv/bin/activate

install the package and its development dependencies

pip install -U pip setuptools
pip install -e .[dev]

Run the tests

pytest tests

Documentation

The user documentation for this tool is hosted with the main documentation site.

Developers: Any updates to this tool should be edited and reflected in the main site documentation as well.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ipr-3.11.0.tar.gz (53.1 kB view details)

Uploaded Source

Built Distribution

ipr-3.11.0-py3-none-any.whl (59.9 kB view details)

Uploaded Python 3

File details

Details for the file ipr-3.11.0.tar.gz.

File metadata

  • Download URL: ipr-3.11.0.tar.gz
  • Upload date:
  • Size: 53.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for ipr-3.11.0.tar.gz
Algorithm Hash digest
SHA256 5e7eb9abd22af11f864e1577dcbdbbb618fb7ed1260e550c991908f7a41332ed
MD5 ee97f7dd5884d0a3ad25d3fda5965059
BLAKE2b-256 bc01e04e6e89bc470259a95071664d4b64dca14720f2069f851c3699554cec88

See more details on using hashes here.

File details

Details for the file ipr-3.11.0-py3-none-any.whl.

File metadata

  • Download URL: ipr-3.11.0-py3-none-any.whl
  • Upload date:
  • Size: 59.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for ipr-3.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 891790d18ada0ce313148a5653ca1001f530437609e7114ca630140d4f6c4cf5
MD5 a2b72f8128a8cf5c20403a097628373a
BLAKE2b-256 9259813dd9b5f02def65d5d8d4312d083969f5318f3a095f9836a17ada6dfc67

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page