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

Uploaded Source

Built Distribution

ipr-3.2.0-py3-none-any.whl (54.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ipr-3.2.0.tar.gz
  • Upload date:
  • Size: 47.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for ipr-3.2.0.tar.gz
Algorithm Hash digest
SHA256 62c1114d61512834ba4f2943acc4cb690ae1748c26426300c9ff83f7bcd693b9
MD5 5008ec95ca72a136f1a53c9f279e5339
BLAKE2b-256 acc0eb8bb221240f1c6536500a71437fe22fe29c58d0273de240a542752e44fc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ipr-3.2.0-py3-none-any.whl
  • Upload date:
  • Size: 54.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for ipr-3.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 88b0e74ea036b3f783844b0ab19ad2d868f14ab530d15c41f82830f9ce205376
MD5 26ef847218f0f18ff672736418f3c534
BLAKE2b-256 56c6aeb7c6057c231c5ffa1cb35a5b90e2b6a372ac1c7cc7dea5ee2432d51e7d

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