How juancgvazquez/modapy works
Project Type and Purpose
• MODA (Multi-Omics Data Analysis) is a precision medicine analytical platform that combines Python-based pipelines (MODApy) and an R/Shiny web interface (MODApy-Shiny.R) to process Whole Exome Sequencing (WES) data.
• The platform supports SNP detection, SNP database generation, comparative analysis (single cases, duos, trios), and is extendable toward RNAseq gene fusion detection and other genomic analyses.
• It is designed to run locally or remotely (via Docker) and integrates both command-line and web-based interactions.
File Structure
• Key directories and files indicate a clear separation of concerns:
• The MODApy directory holds the main Python modules (e.g., vcfanalysis.py, vcfmgr.py, pipeline.py, downloader.py, variantsdb.py) that implement the core business logic.
• The MODApy-Shiny.R file suggests that an R/Shiny-based frontend is used to provide a web interface.
• Configuration files (config.ini, cfg.py) and initialization scripts hint at how the system is set up and customized.
• The docker directory contains a Dockerfile, configuration, requirements, and a startup script, indicating containerized deployment support.
• The tests and docs directories provide structure for quality assurance and documentation, respectively.
Technical Stack and Architectural Patterns
• Backend (Business Logic): Built in Python (MODApy) with modular components handling:
• Data ingestion (downloader.py)
• Data analysis/pipeline processing (pipeline.py, vcfanalysis.py)
• Variant database management (variantsdb.py, parquetvardb.py)
• Utility functions (utils.py, coverage.py, etc.)
• Frontend (Presentation Layer): The Shiny web interface embedded in MODApy-Shiny.R allows users to interact with the system through RStudio Server.
• Deployment & Infrastructure: Docker support enables running the platform in a containerized environment for both local and remote setups.
• External Services: The platform fetches raw sequencing data (e.g., via URLs from sequencing providers) and links to external resources (GeneCards, Varsome, Clinvar, etc.) for detailed annotations.
• Main Components to Include:
• Frontend (Web Interface): Represent with a “Shiny Web Interface” component.
• Configuration & Initialization: Highlight config.ini, cfg.py, and command-line interface (cmd_line.py) as entry points for configuration and execution.
• Data Storage: Although the file structure doesn’t include a dedicated “database” folder, mention the local patient data management and SNP database-generation functionalities as part of the backend.
• Docker & Deployment Environment: Include a “Containerization (Docker)” component that encloses the entire system, showing how the project is deployed.
• Relationship and Data Flow:
• Data output from the analysis modules flowing into the “Variant Database” (or SNP population database) and subsequently out to the frontend for user review.