Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add diagram and logo #28

Merged
merged 2 commits into from
Nov 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
[![nf-core CI](https://github.com/dalmolingroup/euryale/actions/workflows/ci.yml/badge.svg)](https://github.com/dalmolingroup/euryale/actions/workflows/ci.yml)
[![docs](https://github.com/dalmolingroup/euryale/actions/workflows/docs.yml/badge.svg)](https://github.com/dalmolingroup/euryale/actions/workflows/docs.yml)

[![Nextflow](https://img.shields.io/badge/nextflow%20DSL2-%E2%89%A522.10.1-4bc7e2a.svg?labelColor=000000)](https://www.nextflow.io/)
[![run with docker](https://img.shields.io/badge/run%20with-docker-0db7ed?labelColor=000000&logo=docker)](https://www.docker.com/)
[![run with singularity](https://img.shields.io/badge/run%20with-singularity-1d355c.svg?labelColor=000000)](https://sylabs.io/docs/)

![EURYALE Logo](assets/euryale_logo.png)

## Introduction

**dalmolingroup/euryale** is a pipeline for taxonomic classification and functional annotation of metagenomic reads. Based on [MEDUSA](https://github.com/dalmolingroup/medusa).
Expand All @@ -6,6 +15,12 @@ The pipeline is built using [Nextflow](https://www.nextflow.io), a workflow tool

## Pipeline summary

<picture>

<source media="(prefers-color-scheme: dark)" srcset="./assets/euryale_workflow.drawio.png">
<img alt="EURYALE diagram" src="./assets/euryale_workflow.light.png">
</picture>

### Pre-processing

- Read QC ([`FastQC`](https://www.bioinformatics.babraham.ac.uk/projects/fastqc/))
Expand All @@ -21,6 +36,7 @@ The pipeline is built using [Nextflow](https://www.nextflow.io), a workflow tool
### Taxonomic classification

- Sequence classification ([`Kaiju`](https://github.com/bioinformatics-centre/kaiju/))
- (**WIP**) Sequence classification ([`Kraken2`](https://github.com/DerrickWood/kraken2))
- Visualization ([`Krona`](https://github.com/marbl/Krona/wiki))

### Functional annotation
Expand Down
Binary file added assets/euryale_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/euryale_workflow.drawio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/euryale_workflow.light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/euryale_logo.png
1 change: 1 addition & 0 deletions docs/assets/euryale_workflow.drawio.png
1 change: 1 addition & 0 deletions docs/assets/euryale_workflow.light.png
File renamed without changes
Loading