Skip to main content

DiNetxify

Project description

DiNetxify Logo

About DiNetxify

DiNetxify is an open-source Python package for comprehensive three-dimensional (3D) disease network analysis of large-scale electronic health record (EHR) data. It integrates data harmonization, analysis, and visualization into a user-friendly package to uncover multimorbidity patterns and disease progression pathways. DiNetxify is optimized for efficiency (capable of handling cohorts of hundreds of thousands of patients within hours on standard hardware) and supports multiple study designs with customizable parameters and parallel computing. DiNetxify is released under GPL-3.0 license. analytical framework

DiNetxify provides an end-to-end solution for 3D disease network analysis, featuring:

  • Integrated Workflow: From raw EHR data to results and plots. DiNetxify guides you through data preprocessing, sequential analyses, and interactive visualizations in one coherent framework.
  • Flexibility: Supports various cohort study designs, including standard cohort, matched cohort, and exposed-only cohort, and offers numerous parameters to tailor the analysis (e.g. significance thresholds, methods for network construction, etc.).
  • User-Friendly API: High-level functions (e.g. a one-step pipeline) reduce coding overhead, while modular components allow fine-grained control. A dedicated data class handles data loading, cleaning, and ICD code mapping (to phecodes) automatically.
  • Comprehensive Analyses: Combines phenome-wide association studies (PheWAS), comorbidity network analysis, and disease trajectory analysis to identify meaningful disease clusters and temporal sequences concurrently.
  • Visualization: Built-in plotting tools generate interactive 3D network visualizations and static plots for PheWAS results, comorbidity networks, and disease trajectories, facilitating intuitive exploration of findings.

architecture

Installation and Quick Start

Installation

DiNetxify requires Python 3.10+. Install the latest release from PyPI using pip:

pip install dinetxify

This will install DiNetxify along with its dependencies. The required dependencies include: numpy, pandas, matplotlib, plotly, python_louvain, networkx, scikit_learn, scipy, statsmodels (>=0.14.4), and lifelines (optional).

Quick start

To begin using DiNetxify:

  1. Install the package: Use the pip command above to install DiNetxify in your environment (Linux or Windows).

  2. Initialize and load data: Import DiNetxify and create a DiseaseNetworkData object with your chosen study design. Then load your cohort’s phenotype and medical records data into this object. The package will handle data validation and ICD-to-phecode mapping for you. You can download our test dummy data and run the following code:

    import DiNetxify as dnt
    
    # Define required columns and other covariates columns
    col_dict = {'Participant ID': 'ID','Exposure': 'exposure','Sex': 'sex','Index date': 'date_start','End date': 'date_end'}
    vars_lst = ['age', 'BMI']
    # Initialize the data object with study design and phecode level
    data = dnt.DiseaseNetworkData(study_design="cohort",phecode_level=1,date_fmt="%Y-%m-%d")
    # Load the phenotype CSV file into the data object
    data.phenotype_data(phenotype_data_path="dummy_cohort.csv",column_names=col_dict,covariates=vars_lst)
    # Merge with the first medical records file (CSV)
    data.merge_medical_records(medical_records_data_path="dummy_EHR_ICD9.csv",diagnosis_code="ICD-9-WHO",column_names={'Participant ID':'ID','Diagnosis code':'diag_icd9','Date of diagnosis':'dia_date'})
    data.merge_medical_records(medical_records_data_path=path+"/dummy_EHR_ICD10.csv",diagnosis_code="ICD-10-WHO",column_names={'Participant ID':'ID','Diagnosis code':'diag_icd10','Date of diagnosis':'dia_date'})
    
  3. Run the analysis: Utilize the high-level pipeline function to perform the entire 3D network analysis on your DiseaseNetworkData:

    from DiNetxify import disease_network_pipeline
    
    # When using multiprocessing, ensure that the code is enclosed within the following block.
    # This prevents entering a never ending loop of new process creation.
    if __name__ == "__main__":
        results = disease_network_pipeline(data=data, n_process=4,
                                           n_threshold_phewas=100,
                                           n_threshold_comorbidity=100,
                                           output_dir="./results/",
                                           project_prefix="my_analysis")
    

Note: When using multiprocessing, multi-threading may not always close successfully, which can cause conflicts that significantly affect performance. We recommend disabling multi-threading with the following code (Linux):

export OPENBLAS_NUM_THREADS=1
export MKL_NUM_THREADS=1
export BLIS_NUM_THREADS=1
export OMP_NUM_THREADS=1
export NUMEXPR_NUM_THREADS=1

or the following code in Windows:

set OPENBLAS_NUM_THREADS=1
set MKL_NUM_THREADS=1
set BLIS_NUM_THREADS=1
set OMP_NUM_THREADS=1
set NUMEXPR_NUM_THREADS=1

For a detailed tutorial on using DiNetxify, see our documentation at https://hzcohort.github.io/DiNetxify/

Citation

If you use this software in your research, please cite the following papers:

  1. Disease clusters and their genetic determinants following a diagnosis of depression: analyses based on a novel three-dimensional disease network approach (PMID: 40681841)
  2. DiNetxify: a Python package for three-dimensional disease network analysis based on electronic health record data

Contact

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

dinetxify-0.1.5.tar.gz (2.4 MB view details)

Uploaded Source

Built Distribution

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

dinetxify-0.1.5-py3-none-any.whl (2.4 MB view details)

Uploaded Python 3

File details

Details for the file dinetxify-0.1.5.tar.gz.

File metadata

  • Download URL: dinetxify-0.1.5.tar.gz
  • Upload date:
  • Size: 2.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for dinetxify-0.1.5.tar.gz
Algorithm Hash digest
SHA256 872a1d6c2fe493efe39b4bb1d06264719325caae0d0d4aaebf297d026bef2ad8
MD5 1f179de7eefbbeb8b1f4bc676ce8c9cd
BLAKE2b-256 18f41a43afd39039d9111c26e29c9c85b4a2a807aec66237cbd20a2db9a36a10

See more details on using hashes here.

Provenance

The following attestation bundles were made for dinetxify-0.1.5.tar.gz:

Publisher: python-publish.yml on HZcohort/DiNetxify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dinetxify-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: dinetxify-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 2.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for dinetxify-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 60b5d66ca8d0133f4f3fe2a029f25b6cb12c82534aa3ebb714093fefe81bb7bd
MD5 2c49ae21c91fc06d1e141a905852c117
BLAKE2b-256 01ca235116a99a785932a36544ad731b5425a651bd3df8cf7108c3a8d1a9b9f9

See more details on using hashes here.

Provenance

The following attestation bundles were made for dinetxify-0.1.5-py3-none-any.whl:

Publisher: python-publish.yml on HZcohort/DiNetxify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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