https://github.com/rki-mf1/omnifluss

Computational workflow for virus genome reconstruction
https://github.com/rki-mf1/omnifluss

genome-reconstruction nextflow nf-core virus

Last synced: 5 months ago
JSON representation

Computational workflow for virus genome reconstruction

• Host: GitHub
• URL: https://github.com/rki-mf1/omnifluss
• Owner: rki-mf1
• License: mit
• Created: 2024-02-21T09:23:37.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-12-10T12:52:25.000Z (6 months ago)
• Last Synced: 2025-12-10T13:29:07.989Z (6 months ago)
• Topics: genome-reconstruction, nextflow, nf-core, virus
• Language: Nextflow
• Homepage: https://rki-mf1.github.io/omnifluss/
• Size: 3.38 MB
• Stars: 9
• Watchers: 1
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

README

          
[![GitHub Release](https://img.shields.io/github/v/release/rki-mf1/omnifluss)](https://github.com/rki-mf1/omnifluss/releases)

[![Static Badge](https://img.shields.io/badge/Documentation%20-%20website%20-%20brightgreen?logo=Github%20Pages&link=https%3A%2F%2Frki-mf1.github.io%2Fomnifluss%2F)](https://rki-mf1.github.io/omnifluss/)

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/rki-mf1/omnifluss/nf-test.yml?branch=main&logo=githubactions&label=tests%20(%40main))

![GitHub commit activity](https://img.shields.io/github/commit-activity/y/rki-mf1/omnifluss?logo=Github)

# rki-mf1/omnifluss

## Introduction

**rki-mf1/omnifluss**, from _omni_ (Latin: 'all, every') and _Fluss_ (German: 'flow, stream'), is a computational workflow for the reconstruction of virus genomes.

`Omnifluss` takes raw sequencing data and performs operations such as quality filtering, primer clipping, taxanomic classification, alignment, variant calling, consensus assembly, and optionally reference selection.

The specific algorithms and software selected for these operations primarily depend on two parameters: virus type and sequencing technology.

Beside these two parameters many settings and subroutines can be finetuned.

After a successful run, Omnifluss returns a consensus sequence, intermediate files, and an HTML report that includes statistics of the individual operations.

## Usage

Please visit our **[omnifluss website](https://rki-mf1.github.io/omnifluss/)** for our full documentation.

 TL;DR (setup environment) 

You need Nextflow and at least one package manager (conda) or container engine (singularity, docker) available.

You can install Nextflow via conda:

```bash

conda create -n omnifluss -c bioconda -c conda-forge nextflow==25.04.3

conda activate omnifluss

```

 TL;DR (run) 

```bash

nextflow run rki-mf1/omnifluss \

   -r v0.4.0 \

   -profile  \

   --input samplesheet.csv \

   --reference my_virus_reference.fasta \

   --kraken2_db /path/to/my/kraken2db/ \

   --outdir 

```

## Credits

rki-mf1/omnifluss was originally written by the RKI MF1 Viroinf team.

## Funding

This project was supported by co-funding from the European Union’s EU4Health programme under project no. 101113012 (IMS-HERA2).

## Citations

\

An extensive list of references for the tools used by the pipeline can be found in the [`CITATIONS.md`](CITATIONS.md) file.