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

Uploaded Source

Built Distribution

ipr-3.12.2-py3-none-any.whl (60.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ipr-3.12.2.tar.gz
Algorithm Hash digest
SHA256 9b10182f3a1caef6190ead0824d06b7bff70c50cd5ac1bf87dca8d1483b7e9d9
MD5 39803e62155c8fd4359891b47b2ee91e
BLAKE2b-256 13d8dc707f7ef2b31917acc6341965e3db16625677fdfb01fe147a0bd7171dcf

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ipr-3.12.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6d1087fae56037f55a47e011fd9122d1b501f5b8815e6c3ce76590fca40ad9dd
MD5 43a274aa52c90064b062818460739277
BLAKE2b-256 a7947d51ebc0a7846e5006a7f6838f3230484a95e92a159e5ede20be8bdb6035

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