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.13.0.tar.gz (54.8 kB view details)

Uploaded Source

Built Distribution

ipr-3.13.0-py3-none-any.whl (61.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ipr-3.13.0.tar.gz
  • Upload date:
  • Size: 54.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for ipr-3.13.0.tar.gz
Algorithm Hash digest
SHA256 6ea67de2faeec895d09d442a0fecdbd3834dc85492951699040b3bc679bbf62c
MD5 02dc657702c55c16d8d27b31f8bc7766
BLAKE2b-256 94642a994294af554a8f8768471473769c18e0882a65d23e435607317de6863d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ipr-3.13.0-py3-none-any.whl
  • Upload date:
  • Size: 61.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for ipr-3.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1e576d700d8f32279f11057cc21c49f7c2a27c03841eec27ed56f16e02bfe890
MD5 a779860a88f0674e85e2516aa5542ce5
BLAKE2b-256 f047ce9c84ac5c07ecfc5996559e87ee32bdca6c6d78078c69a122a4bc270159

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