How nf-cmgg/wisecondorx works
Project type and purpose
• This is an nf-core bioinformatics pipeline written in Nextflow DSL2.
• Its goal is to run the WisecondorX tool in two stages:
• “convert”: transform alignment files into NPZ format
• “newref”: build a reference from all NPZ files
• It follows the nf-core standard: modularized code, centralized configuration, containerized environments, CI testing.
File structure
• Top-level workflow:
• main.nf (imports workflows/wisecondorx.nf)
• workflows/wisecondorx.nf (defines the two main stages)
• Modules directory: modules/nf-core/...
• Each module has: main.nf (process), environment.yml (Conda), meta.yml (documentation), tests
• Subworkflows: reusable composites in subworkflows/nf-core and subworkflows/local
• Configuration:
• nextflow.config + nf-core.yml + conf/*.config (institute, test settings)
• tower.yml (Seqera Tower integration)
• Assets: report templates (adaptivecard.json, email templates, slackreport.json)
• Tests:
• tests/ (pipeline-level)
• module and subworkflow tests under their own directories
• CI & tooling: GitHub workflows, nf-test integration, pre-commit, .devcontainer, Docker/Singularity/Conda support.
README
• Confirms the two-step pipeline and how to run with Nextflow profiles
• Mentions container support and nf-core community standards
• Points to parameter docs and citations
• Nextflow Engine (runtime orchestrator)
• Workflow layer: main.nf + workflows/wisecondorx.nf
• Modules (modules/nf-core/…): encapsulated Nextflow processes
• Subworkflows (subworkflows/…): reusable composite workflows
• Configuration (nextflow.config, conf/*.config, nf-core.yml)
• Assets & Reporting Templates (assets/)
• External Services: Conda, Docker Hub, Singularity, Seqera Tower
• Test Suite (tests/, module tests, CI pipelines)
• Data Storage: Input samplesheet & FASTQ/BAM, NPZ outputs, reference outputs
b. Relationships and data flow:
1. User supplies input samplesheet → Nextflow Engine
2. Nextflow Engine reads configuration → selects profiles (docker/singularity/conda)
3. Workflow layer invokes subworkflows and modules in sequence:
• convert subworkflow (modules/nf-core/wisecondorx/convert) → NPZ files
• newref subworkflow (modules/nf-core/wisecondorx/newref) → reference NPZ
4. Each module pulls its Conda/Docker/Singularity environment, executes processes.
5. Assets are used to generate reports (email, Slack, multiQC)
6. Outputs written to outdir.
7. CI & nf-test run pipeline and module tests on commits.
8. Seqera Tower (optional) triggers runs and monitors status.
c. Architectural patterns & principles:
• DSL2 modularization: clear separation between workflows, modules, and subworkflows
• Infrastructure-as-code: config files declare compute profiles, parameters, environments
• Container-first design: reproducible environments via Conda, Docker, Singularity
• nf-core conventions: standard directory layout, CI integration, community guidelines
d. Key technologies & frameworks:
• Nextflow DSL2
• nf-core modules & templates
• Conda / Docker / Singularity
• GitHub Actions (ci.yml, linting.yml, etc.)
• nf-test for pipeline validation
• Seqera Tower for cloud execution