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

Uploaded Source

Built Distribution

ipr-3.9.0-py3-none-any.whl (61.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ipr-3.9.0.tar.gz
Algorithm Hash digest
SHA256 e918b768f9c76a97617c57bb46ed949afc2d499dd720e6d865b0ec0860263836
MD5 97b625d5a02cf027f63f5d0b879448ca
BLAKE2b-256 cf4533a0549e87c191471b14a3335bb95fd07a27052e82735cae451477d45538

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ipr-3.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bf9e65429fcf6d0e068461356e71c3f11b6aa97f4151ee2d28afb4941cf2fb73
MD5 9d52adfb30e7e3151367a2eef464a474
BLAKE2b-256 832d2238ad6366b1f65709eaacc991afc08a71979c1b47fcb62e7af8d5d9c3ca

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