Skip to main content

No project description provided

Project description

IDeRare-Pheno

CI PyPI License Streamlit FastAPI

IDeRare or "Indonesia Exome Rare Disease Variant Discovery Pipeline" is a simple and ready to use variant discovery pipeline to discover rare disease variants from exome sequencing data.

This repository is the first part of IDeRare workflow for phenotype analysis. For complete pipeline for phenotype-genotype analysis, kindly refer to IDeRare Github repository.

Authored by

Ivan William Harsonoa, Yulia Arianib, Beben Benyaminc,d,e, Fadilah Fadilahf,g, Dwi Ari Pujiantob, Cut Nurul Hafifahh

aDoctoral Program in Biomedical Sciences, Faculty of Medicine, Universitas Indonesia, Jakarta, Indonesia.
bDepartment of Medical Biology, Faculty of Medicine, Universitas Indonesia, Jakarta, Indonesia.
cAustralian Centre for Precision Health, University of South Australia, Adelaide, SA, 5000, Australia.
dUniSA Allied Health and Human Performance, University of South Australia, Adelaide, SA, 5000, Australia.
eSouth Australian Health and Medical Research Institute (SAHMRI), University of South Australia, Adelaide, SA, 5000, Australia.
fDepartment of Medical Chemistry, Faculty of Medicine, Universitas Indonesia, Jalan Salemba Raya number 4, Jakarta, 10430, Indonesia.
gBioinformatics Core Facilities - IMERI, Faculty of Medicine, Universitas Indonesia, Jalan Salemba Raya number 6, Jakarta, 10430, Indonesia .
hDepartment of Child Health, Dr. Cipto Mangunkusumo Hospital, Faculty of Medicine, University of Indonesia, Jakarta, Indonesia.

How to Cite

Please kindly cite the main paper titled "IDeRare: a lightweight and extensible open-source phenotype and exome analysis pipeline for germline rare disease diagnosis" available at https://doi.org/10.1093/jamiaopen/ooae052

Example :

Ivan William Harsono, Yulia Ariani, Beben Benyamin, Fadilah Fadilah, Dwi Ari Pujianto, Cut Nurul Hafifah, IDeRare: a lightweight and extensible open-source phenotype and exome analysis pipeline for germline rare disease diagnosis, JAMIA Open, Volume 7, Issue 2, July 2024, ooae052, https://doi.org/10.1093/jamiaopen/ooae052

Quick links

What does it do?

This script is recommended if you would like to do conversion, linkage analysis, similarity scoring, and gene-disease recommendation based on the phenotype data provided at clinical_data.txt. Full feature :

  1. Convert the phenotype data to HPO code (accept mixed SNOMED, LOINC, and HPO code)
  2. Similarity scoring of differential diagnosis
  3. Linkage analysis of differential diagnosis (accept mixed SNOMED, ICD-10, ORPHA, OMIM code), include dendrogram tree visualization.
    • This should help clinician to systematically doing work-up and excluding similar diagnosis together based on the patient's phenotype.
  4. Gene and disease recommendation based on the phenotype data similarity scoring between phenotype and OMIM gene and disease databank.
  5. Linkage analysis of recommended causative gene and disease based on phenotype data (include dendrogram tree visualization).
    • This should help clinician to explore / enrich their differential diagnosis based on the patient's phenotype.
  6. Example of the clinical data provided at Clinical Information Example section

Installation

iderare-pheno requires Python 3.10 or later.

Installing with pip

iderare-pheno is available on PyPI. Just run

pip install iderare-pheno

Installing from source

To install iderare-pheno from source, first clone the repository:

git clone https://github.com/ivanwilliammd/iderare-pheno.git
cd iderare_pheno

Then run

pip install -e .

Importing the library

from iderare_pheno.converter import term2omim, term2orpha, term2hpo, batchconvert
from iderare_pheno.simrec import hpo2omim_similarity, omim_recommendation, hpo2name, omim2name
from iderare_pheno.utils import linkage_dendrogram, list2tsv, generate_yml

As the complete readthedocs.io is being finalized, please kindly refer to this Interactive Playbook Example

Note : for Streamlit implementation, use iderare_pheno.streamlit_utils instead of iderare_pheno.utils, this was done to prevent file to automatically saving and showing dendrogram in Streamlit.

from iderare_pheno.streamlit_utils import linkage_dendrogram, list2tsv, generate_yml

For Python FastAPI implementation and FHIR code extraction / parsing and deploying wsgi app, ensure you have installed the dependencies below:

pip install fastapi uvicorn a2wsgi

Then prepare your passenger wsgi app and main FastAPI app as below:

passenger_wsgi.py

import os
import sys
from a2wsgi import ASGIMiddleware

# Adjust the path to your FastAPI application directory if needed
app_dir = os.path.join(os.path.dirname(__file__), 'app')
sys.path.insert(0, app_dir)

# Import your FastAPI application
from app.main import app  # Assuming your FastAPI app instance is named 'app'

# Application callable for Passenger WSGI
def application(environ, start_response):
    return ASGIMiddleware(app)(environ, start_response)

app/main.py

from fastapi.responses import RedirectResponse
from iderare_pheno.fhir_parser import *

@app.get("/")
async def welcome():
    return RedirectResponse(status_code=302, url="/docs")

@app.get("/health")
async def health() -> Response :
    return {"status_code" : 200, "detail" : "The services is running, try to explore the API from Postman Collection"}

if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app, host="0.0.0.0", port=8000)

Now you could access your http://localhost:8000 and redirected to Swagger to see the documentation of the available FastAPI endpoint. Demo example could be accessed via Postman Collection at here

Team

iderare-pheno is developed and maintained by the author(s), To learn more about who specifically contributed to this codebase, see our contributors page.

License

iderare-pheno license is derived from IDeRare

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

iderare_pheno-1.0.1.tar.gz (10.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iderare_pheno-1.0.1-py3-none-any.whl (10.4 MB view details)

Uploaded Python 3

File details

Details for the file iderare_pheno-1.0.1.tar.gz.

File metadata

  • Download URL: iderare_pheno-1.0.1.tar.gz
  • Upload date:
  • Size: 10.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.16

File hashes

Hashes for iderare_pheno-1.0.1.tar.gz
Algorithm Hash digest
SHA256 1bd30bb9c89afdeb593c61be3bcc2cb1490a6c0a0e1f0bd03734dfa9fddf28e6
MD5 f796d26b12b5128302f96f3cf6bd1d37
BLAKE2b-256 7d39422314b60ac39bde05ec42610d41793f6ec8f94b0d5aafba464a58c3f5b5

See more details on using hashes here.

File details

Details for the file iderare_pheno-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: iderare_pheno-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 10.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.16

File hashes

Hashes for iderare_pheno-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ccaf6a1e99c9fd31ee2e8c4d1f1024d8158431ac57c33ee8c88d1aa9c83bd672
MD5 0e125c09d3089c18c505ca8ad4bb5747
BLAKE2b-256 b741dbaacddd16eef7f33d63e1ab41748a80af27e7c0d55c86591e0a6ae2b120

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page