How alesanzdro/epibac works
Main Components
• Environment Setup and Package Management: Represent the use of Conda and Mamba for environment management. Show the “base” environment (for mamba and conda configuration) and the dedicated “snake” environment for Snakemake execution.
• Input Data/External Resources: Include components for:
• Raw input files (FASTQ files and samples_info/samplesheet in the “test” and “RAWDATA” directories).
• Configuration and schema files (config.yaml, schemas directory) that govern pipeline behavior and input validation.
• Snakemake Workflow Engine: This is the core orchestrator of the pipeline. Represent the workflow as:
• A block for the Snakemake engine.
• Subcomponents that correspond to the individual rule files located in the “rules” directory (such as assembly.smk, qc.smk, annotation.smk, report.smk, setup.smk, and amr_mlst.smk). Each rule represents a processing step, and collectively they form the Directed Acyclic Graph (DAG) of the pipeline.
• Supporting Scripts & Utilities: Include the “scripts” directory, which has helper programs for generating a samplesheet and validating the sample information.
• Testing and Validation: A component showing the test data as exemplified in the “test” folder, used for both pipeline’s execution validation and demonstration (including example outputs, like report.html and dag.png).
Relationships and Data Flow
• That the outputs of these rules are aggregated into a final report (as illustrated by the report.smk rule and eventual Excel outputs), and there’s also a separate report format for hospital-specific “GVA” needs.
Architectural Patterns and Key Technologies
• Use of a workflow engine (Snakemake) which inherently supports modularization and parallel execution.
• Reproducibility provided by the use of conda environments (with environment YAML files in the “envs” directory).
• Extent to which the pipeline adheres to common bioinformatics practices: separation of configuration (config.yaml, schemas), rule-based processing (rules/*.smk), and container-like environment reproducibility.
• External services like Git for version control (note the .gitignore and authors.md).