Skip to content

🐙 CPG Flow

CPG Flow logo

Python

⚙️ Test Workflow 🚀 Deploy To Production Workflow GitHub Latest Main Release GitHub Release semantic-release: conventional commits GitHub license

Tests Coverage

Technical Debt Duplicated Lines (%) Code Smells


📋 Table of Contents

  1. 🐙 What is this API ?
  2. ✨ Documentation
  3. 🔨 Installation
  4. 🚀 Build
  5. 🤖 Usage
  6. 😵‍💫 Key Considerations and Limitations
  7. 🐳 Docker
  8. 💯 Tests
  9. ☑️ Code analysis and consistency
  10. 📈 Releases & Changelog
  11. 🎬 GitHub Actions

🐙 What is this API ?

Welcome to CPG Flow!

This API provides a set of tools and workflows for managing population genomics data pipelines, designed to streamline the processing, analysis, and storage of large-scale genomic datasets. It facilitates automated pipeline execution, enabling reproducible research while integrating with cloud-based resources for scalable computation.

CPG Flow supports various stages of genomic data processing, from raw data ingestion to final analysis outputs, making it easier for researchers to manage and scale their population genomics workflows.

The API constructs a DAG (Directed Acyclic Graph) structure from a set of chained stages. This DAG structure then forms the pipeline.

✨ Documentation

🌐 Production

The production version of this API is documented at populationgenomics.github.io/cpg-flow/.

The documentation is updated automatically when a commit is pushed on the alpha (prerelease) or main (release) branch.