How hivdb/hivfacts works
Main Components
a) Data Processing Layer
• Separate modules for HIV-1 and HIV-2 data processing
• Data validation components
• Mutation analysis systems
b) Core Data Storage
• Structured data files (JSON, CSV, YAML)
• Algorithm definitions
• Reference data
c) Language-Specific Implementation Layer
• Java implementation
• Python implementation
Key Architectural Elements
[Data Sources]
• ↓
[Data Processing Pipeline]
• ↓
[Core Data Storage] ←→ [Validation Layer]
• ↓
[Language Implementations]
• ↓
[Client Applications]
Component Details
a) Data Processing Pipeline:
• APOBEC Filter Processing
• Mutation Analysis
• Statistical Analysis
• Data Format Converters (CSV/JSON/YAML)
b) Core Data Storage (organize in sections):
• Algorithms (/data/algorithms/)
• Mutation Data (/data/drms_*)
• Reference Data (genotypes, strains)
• Statistical Data (aapcnt, codonpcnt)
c) Validation Components:
• Sequence Validators
• Mutation Validators
• Quality Assurance Checks
Implementation Details
a) Java Implementation:
• Main classes (HIV.java, HIVDataLoader.java)
• Validation components
• Type-specific implementations
b) Python Implementation:
• Main modules (hivaapcnt.py, hivapobec.py)
• Data access patterns
• Processing components
Key Relationships to Highlight
• Data processing workflows
• Validation chains
• Implementation interfaces
• Configuration management
• Version control points
Remember to include notes about the quality assurance criteria mentioned in the README, particularly the sequence QA criteria and APOBEC cutoff values, as these are critical to the system's operation.
This architecture should emphasize the system's ability to handle both HIV-1 and HIV-2 data while maintaining strict validation and quality control throughout the processing pipeline.