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

Uploaded Source

Built Distribution

ipr-3.4.0-py3-none-any.whl (56.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ipr-3.4.0.tar.gz
Algorithm Hash digest
SHA256 505eeaf9bd1600da04814dc1006579f8eb8947557b0bd36f61aa3ceb289db64a
MD5 d90c1a25719d3f441b2c5c70d1efc00a
BLAKE2b-256 eb1ccfa16eae148784413df0a9efc543b1eed47d47f45f5e38e469e2d8558b9c

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ipr-3.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0f3bb8833d0abb9325f357a0c330ae556b0f421136a86934119b27030941f68e
MD5 6a74e05206d8cb78d6fce79f96482d67
BLAKE2b-256 353a31cecd92609207f5ea012701acf08144d4df699980bd15e6d61fac480385

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