Lokasi ngalangkungan proxy:   [ UP ]  
[Ngawartoskeun bug]   [Panyetelan cookie]                
Skip to content

CNAG-Biomedical-Informatics/cbicall

Repository files navigation

CBIcall

CNAG Biomedical Informatics framework for variant calling

Build version Coverage Status Docker Build Docker Image Size Docker Pulls Documentation Status License


CBIcall (CNAG Biomedical Informatics framework for variant calling) is a configuration-driven framework for reproducible variant calling in large sequencing cohorts. It validates analysis intent, resolves approved workflow backends and resource definitions, and records structured run reports for auditable production runs and run-to-run comparison.

📘 Documentation: https://cnag-biomedical-informatics.github.io/cbicall

🐳 Docker Hub Image: https://hub.docker.com/r/manuelrueda/cbicall/tags

Table of contents

CBIcall orchestrates germline variant calling workflows for Illumina sequencing data. It does not implement variant calling algorithms itself. Instead, it validates parameters, resolves workflows from a versioned registry, checks resource compatibility, launches native CBIcall workflows through Bash, Snakemake, Nextflow, or Cromwell backends, and captures audit artifacts for traceability. Selected external nf-core workflows can also run through the same validation and provenance layer.

CBIcall uses a three-part execution contract:

Contract layer Purpose
Parameters YAML User analysis intent: inputs, pipeline, mode, genome, backend, and runtime options.
Workflow registry Approved workflow implementations and backend-specific entrypoints.
Resource catalog External references, tool/resource bundles, compatibility rules, and resource identity.

Key points:

  • Configuration-driven execution from a YAML parameter file
  • Native CBIcall workflow support through Bash, Snakemake, Nextflow, and Cromwell backends
  • Support for WES, WGS, and mtDNA analysis modes
  • Registry-backed support for selected external nf-core/Nextflow workflows
  • Structured audit artifacts: log.json, run-report.json, optional run-report.html, workflow fingerprints, resource identity, output inventories, and normalized VCF hashes
  • Programmatic run comparison with cbicall compare-runs
  • Optional partial workflow starts for supported backends

Workflow sources:

Source Role
Native CBIcall workflows Packaged WES/WGS/mtDNA pipelines with CBIcall validation, logging, and output structure.
External nf-core workflows Selected registry-backed Nextflow workflows executed with CBIcall validation and provenance.

Quick Start

bin/cbicall run -p params.yaml -t 8

Runnable examples and sample inputs are available under examples/.

Documentation

The full technical reference lives in the documentation site and repository docs:

Citation

CBIcall: a configuration-driven framework for variant calling in large sequencing cohorts. Preprint DOI.

Author

Written by Manuel Rueda (mrueda). GitHub repository: https://github.com/CNAG-Biomedical-Informatics/cbicall.

Copyright and license

Please see the included LICENSE file for distribution and usage terms.

About

CBIcall is a configuration-driven framework for reproducible variant calling in large sequencing cohorts, enabling standardized pipelines from FASTQ to analysis-ready VCFs across heterogeneous computing environments.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors