Computable object representation and validation for gene fusions
Project description
FUSOR
FUSOR (FUSion Object Representation) provides modeling and validation tools for representing gene fusions in a flexible, computable structure.
Installation
Package
To install FUSOR:
python3 -m pip install fusor
SeqRepo and UTA
FUSOR relies on data from SeqRepo and the Universal Transcript Archive (UTA), supplied via Cool-Seq-Tool. See the Cool-Seq-Tool installation instructions for specifics on setting up SeqRepo and UTA.
To connect to the UTA database, you can use the default url (postgresql://uta_admin@localhost:5433/uta/uta_20210129). If you use the default url, you must either set the password using environment variable UTA_PASSWORD or setting the parameter db_pwd in the FUSOR class.
If you do not wish to use the default, you must set the environment variable UTA_DB_URL which has the format of driver://user:pass@host:port/database/schema.
Gene Normalizer
FUSOR also relies on data from the Gene Normalizer, which you must download yourself. See the README for deploying the gene database.
Development
Setup
Clone the repo:
git clone https://github.com/cancervariants/fusor
cd fusor
Create a virtual environment, and activate it:
python3 -m virtualenv venv
source venv/bin/activate
Install test and dev dependencies:
python3 -m pip install -e '.[dev,tests]'
Style
Code style is managed by Ruff and checked prior to commit.
python3 -m ruff format . && python3 -m ruff check --fix .
We use pre-commit to run conformance tests.
This performs checks for:
- Code style
- File endings
- Added large files
- AWS credentials
- Private keys
Before your first commit, run:
pre-commit install
Unit tests
Unit testing is provided via pytest:
pytest
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file fusor-0.1.0.tar.gz.
File metadata
- Download URL: fusor-0.1.0.tar.gz
- Upload date:
- Size: 36.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a96514fb914799ea4d096026756b250f5dcf5c80d419f9f8298bab64e3d541a3 |
|
| MD5 | 303998088540e1b54891a679b20dbba2 |
|
| BLAKE2b-256 | 345679e63e25206c05b15358ca7ab9a09db0a73cd3eb37fae6b7ca055a095a6d |
File details
Details for the file fusor-0.1.0-py3-none-any.whl.
File metadata
- Download URL: fusor-0.1.0-py3-none-any.whl
- Upload date:
- Size: 27.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cf4cc7c54562f4d1440a5de09b72f8b7a6fde9d1de361d1d5fcffd80c96bf5d8 |
|
| MD5 | 2ea8365a1e25492aa0160ae589330fac |
|
| BLAKE2b-256 | 1df17a4decb646f18d63b2ad8b89dbb8e8b21523269c2090f7394fc5e85c0b2a |
