# IPR
![build](https://github.com/bcgsc/pori_ipr_python/workflows/build/badge.svg) [![PyPi](https://img.shields.io/pypi/v/ipr.svg)](https://pypi.org/project/ipr) [![codecov](https://codecov.io/gh/bcgsc/pori_ipr_python/branch/master/graph/badge.svg)](https://codecov.io/gh/bcgsc/pori_ipr_python) [![PyPI - Downloads](https://img.shields.io/pypi/dm/ipr)](https://pypistats.org/packages/ipr)
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.
## 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 -e .[dev]
```
Run the tests
```
pytest tests
```
## Generating the Documentation
This documentation is generated using [mkdocs](https://www.mkdocs.org), [mkdocs-material](https://pypi.org/project/mkdocs-material), and [markdown_refdocs](https://pypi.org/project/markdown-refdocs).
First install the documentation dependencies
```bash
pip install .[doc]
```
Then generate the user manual files
```bash
markdown_refdocs ipr -o docs/reference
mkdocs build
```
There should now be static html files under `build-docs`. To view the files, serve the folder using
the built-in python http server
```bash
python3 -m http.server -d build-docs
```
没有合适的资源?快使用搜索试试~ 我知道了~
温馨提示
共32个文件
py:21个
txt:5个
pkg-info:2个
资源分类:Python库 所属语言:Python 资源全名:ipr-2.0.0.tar.gz 资源来源:官方 安装方法:https://lanzao.blog.csdn.net/article/details/101784059
资源推荐
资源详情
资源评论
收起资源包目录
ipr-2.0.0.tar.gz (32个子文件)
ipr-2.0.0
MANIFEST.in 41B
PKG-INFO 2KB
tests
constants.py 90B
test_ipr.py 5KB
test_annotate.py 2KB
test_inputs.py 10KB
test_summary.py 7KB
__init__.py 0B
test_probe.py 2KB
test_connection.py 3KB
test_main.py 3KB
ipr
constants.py 463B
main.py 12KB
py.typed 0B
summary.py 14KB
types.py 1KB
therapeutic_options.py 2KB
util.py 6KB
inputs.py 18KB
__init__.py 0B
connection.py 4KB
annotate.py 12KB
ipr.py 8KB
setup.cfg 235B
setup.py 1KB
ipr.egg-info
PKG-INFO 2KB
requires.txt 298B
SOURCES.txt 573B
entry_points.txt 52B
top_level.txt 10B
dependency_links.txt 1B
README.md 2KB
共 32 条
- 1
资源评论
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功