How rivm-bioinformatics/ampligone works
Main Components
a. Input Processing Layer:
• FastQ file input handling (Illumina/Nanopore data)
• Reference sequence input
• Primer coordinates input
b. Core Processing Components:
• Mapping/Alignment Module
• Primer Detection Module
• Read Trimming Engine
• Coordinate Translation System
c. Output Processing Layer:
• Cleaned FastQ generation
• Quality control metrics
┌─────────────────────────────────────┐
• Input Layer │
• FastQ Files │
• Reference Sequences │
• Primer Coordinates │
• ┘
• ↓
┌─────────────────────────────────────┐
• Processing Core │
• ┌─────────────┐ ┌────────────┐ │
• Mapping │ → │Coordinate │ │
• Module │ │Processing │ │
• ┘ └────────────┘ │
• ↓ ↓ │
• ┌─────────────┐ ┌────────────┐ │
• Primer │ → │ Read │ │
• Detection │ │ Trimming │ │
• ┘ └────────────┘ │
• ┘
• ↓
┌─────────────────────────────────────┐
• Output Layer │
• Cleaned FastQ Files │
• QC Metrics │
• ┘
Key Components to Highlight
• cut_reads.py: Primary read processing
• cutlery.py: Core trimming functions
• fasta2bed.py: Reference sequence handling
• mappreset.py: Mapping configurations
• func.py: Utility functions
• io_ops.py: Input/Output operations
Important Relationships
• Data flow direction between components
• Feedback loops for quality control
• Error handling paths
• Parallel processing capabilities
Technical Details
• Supported file formats (FastQ)
• Supported sequencing platforms (Illumina, Nanopore)
• Amplicon type handling (end-to-end, end-to-mid, fragmented)
• Reference coordinate system