How aagi-aus/pacb-flow works
Main Components
a) Input Layer:
• Long reads data source
• Short reads data source
• Reference genome (optional)
• Manifest file (samples.csv)
b) Pipeline Stages:
• Primary Assembly Stage
• Scaffolding Stage (optional)
• Polishing Stage
• Coverage Analysis Stage
c) Infrastructure Components:
• Nextflow Runtime Environment
• HPC/Supercomputer Environment
• Container System (Singularity)
┌─────────────────────────────────────────────────────────────┐
• Input Layer │
• ┘
• ↓
┌─────────────────────────────────────────────────────────────┐
• Workflow Controller │
• (Nextflow main.nf runner) │
• ┘
• ↓
┌─────────────────────────────────────────────────────────────┐
• Processing Stages │
• ┘
• ↓
┌─────────────────────────────────────────────────────────────┐
• Output Layer │
• ┘
Detailed Component Breakdown
The Processing Stages should be expanded to show:
a) Primary Assembly (CANU):
• Read trimming
• Read correction
• Assembly
b) Scaffolding (Optional):
• ntLink (long read scaffolding)
• ntJoin (reference-based scaffolding)
c) Polishing:
• Polypolish module
d) Coverage Analysis:
• BWA mapping
• Bedtools coverage
• UCSC utilities
Key Relationships to Highlight
• Data flow between stages
• Optional pathway activation based on parameters
• Resource allocation points
• Parallel execution possibilities
Technical Details
• Module dependencies
• Configuration profiles (pawsey_setonix, singularity)
• Resource requirements (>100GB memory peak)
• Input/Output file formats
Infrastructure Layer
Relationship with:
• HPC environment
• Container runtime
• Storage systems
• Resource managers
Metadata
A metadata section with:
• Pipeline version
• Required Nextflow version (>22.10.7)
• Author information
• License information
Remember to include subworkflow relationships as shown in the file structure, particularly the relationship between the main workflow and local subworkflows in the 'subworkflows/local' directory.
This system design should provide a clear understanding of both the high-level architecture and the detailed workflow steps, making it valuable for both new team members and experienced developers maintaining the pipeline.