How arthurvm/afanc works
Main Components and Architecture
a) Core Components (Top Level):
• get_dataset → autodatabase → screen
b) External Dependencies Layer:
• NCBI Tools (Entrez, BLAST+, Datasets)
• Analysis Tools (Mash, Kraken2, Bowtie2)
• Visualization Tools (Krona)
Detailed Module Breakdown
For each main module, create a sub-section showing internal components:
a) get_dataset Module:
• Input: Species list/accession IDs
• Process: download_assemblies.py
• Output: Hierarchical directory structure
b) autodatabase Module:
• Components:
• Assembly QC (assemblyQC.py)
• FASTA Processing (prepareNewFasta.py)
• Taxonomy Management (taxadd.py)
• Variant Indexing (makeVariantIndex.py)
• Database Construction Flow
c) screen Module:
• Components:
• Genome Processing (getGenomes.py)
• Mapping (mapHits.py)
• Variant Profiling (variant_profiler/)
• Report Generation (report/)
Data Flow Representation
• Input Files → Processing → Output Files
• File formats (FASTA, FASTQ, JSON)
• Database interaction points
Key Design Elements
Specific features:
• Input/Output formats at each stage
• External dependency connections
• Database interaction points
Technical Details
Annotations for:
• Python version requirement (3.7+)
• Key file formats
• Database structures
• Processing stages
Bottom: External dependencies
• File format indicators
• Modular design
• Pipeline workflow
• Data transformation stages
• External tool integration
• Database construction and usage
Remember to highlight the unique features of Afanc:
• Variant-level metagenomic analysis
• Automated database construction
• Integration with multiple bioinformatics tools
• Hierarchical taxonomy handling
• High-resolution screening capabilities
This will provide a clear understanding of both the system's architecture and its functional workflow.