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

Uploaded Source

Built Distribution

ipr-3.5.1-py3-none-any.whl (60.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ipr-3.5.1.tar.gz
  • Upload date:
  • Size: 53.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.7

File hashes

Hashes for ipr-3.5.1.tar.gz
Algorithm Hash digest
SHA256 faa21b98146b313bb03d3e702bf88e21e1402f0a5286c5ee1e0b6d2f73d92e79
MD5 8f47ea4dc5bae9127efe788fd0de157b
BLAKE2b-256 7b9d1917f2c47fa43409f0f3e08deab38a2cb87152daee346e8b909515b452f7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ipr-3.5.1-py3-none-any.whl
  • Upload date:
  • Size: 60.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.7

File hashes

Hashes for ipr-3.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d74624b7eac36a60070dac33d59fa4a31f84a5547eb00fa9d24b7094f5b8ba48
MD5 9e594edf2ea5f32fb18c4430da2dfe0e
BLAKE2b-256 a0e52bac6d48c60c8f488eb4a9b9ffb49a5bf120ab03bad78a055c3768e29a2c

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