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

Uploaded Source

Built Distribution

ipr-3.7.0-py3-none-any.whl (61.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ipr-3.7.0.tar.gz
Algorithm Hash digest
SHA256 707e9b1ce513bdde7d4a30032896f3334595cde63a44260fccdf73b83aae8585
MD5 db1bd220486004efe2ca85d190cbfbde
BLAKE2b-256 fdeb3c896c7f662cb7cd6727a8d9df6a27b15bc06b8c3524ba8e86759c8e009c

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ipr-3.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5de22802eefbb66b3c33d9ac0359705e6a826010e53a31f33cc63db9cb1d6ba6
MD5 ab6f56f3b83c1f7706ffc6246109453c
BLAKE2b-256 c2bc50d019f6bf703c0b4273031425f67b87cc6eb64d7d8bfe499ea9a05bad90

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