Skip to content

Commit

Permalink
Merge pull request #88 from jaebeom-kim/master
Browse files Browse the repository at this point in the history
Update Readme
  • Loading branch information
jaebeom-kim authored Sep 19, 2024
2 parents 8fd3112 + 33d2ce5 commit 5cf8577
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
Binary file added .github/metabuli.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat)](http://bioconda.github.io/recipes/metabuli/README.html)
[![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat)](http://bioconda.github.io/recipes/metabuli/README.html)
![Platform](https://img.shields.io/badge/platform-Mac%20%7C%20Windows%20%7C%20Linux-brightgreen)
# Metabuli
***Metabuli*** classifies metagenomic reads by comparing them to reference genomes. You can use Metabuli to profile the taxonomic composition of your samples or to detect specific (pathogenic) species.

Expand All @@ -24,7 +25,13 @@ Please cite: [Kim J, Steinegger M. Metabuli: sensitive and specific metagenomic
<p align="center"><img src="https://raw.githubusercontent.com/steineggerlab/Metabuli/master/.github/marv_metabuli_small.png" height="350" /></p>

---
### 🖥️ Metabuli App for Windows, MacOS, and Linux are [here](https://github.com/steineggerlab/Metabuli-App).
### 🖥️ [Metabuli App](https://github.com/steineggerlab/Metabuli-App) for Windows, MacOS, and Linux are now available!
> Run taxonomic profiling in just a few clicks and explore results with Sankey and Krona plots.
> Download the app for your OS [here](https://github.com/steineggerlab/Metabuli-App/releases)—no separate Metabuli installation needed.
<p align="center"><img src="https://raw.githubusercontent.com/jaebeom-kim/Metabuli/master/.github/metabuli.jpg" height="500" /></p>

---
### Update in v1.0.7
- **Metabuli became faster 🚀**
Expand Down Expand Up @@ -75,6 +82,8 @@ make -j 16
```
The built binary can be found in `./build/src`.

---

## Pre-built databases
You can download [pre-built databases](https://metabuli.steineggerlab.workers.dev/) using `databases` workflow.

Expand Down Expand Up @@ -111,6 +120,7 @@ metabuli databases RefSeq_release OUTDIR tmp
```
Downloaded files are stored in `OUTDIR/DB_NAME` directory, which can be provided for `classify` module as `DBDIR`.

---

## Classification
```
Expand Down Expand Up @@ -190,6 +200,8 @@ It is for an interactive taxonomy report (Krona). You can use any modern web bro
Metabuli can classify reads against a database of any size as long as the database is fits in the hard disk, regardless of the machine's RAM size.
We tested it with a MacBook Air (2020, M1, 8 GiB), where we classified about 15 M paired-end 150 bp reads (~5 GiB in size) against a database built with ~23K prokaryotic genomes (~69 GiB in size).

---

## Custom database
To build a custom database, you need three things:
1. **FASTA files** : Each sequence of your FASTA files must be separated by '>accession.version' like '>CP001849.1'. The accession doesn't have to follow the NCBI format, but it must be unique and included in the accession2taxid file.
Expand Down Expand Up @@ -297,6 +309,7 @@ metabuli build <DBDIR> <LIB_FILES> <accession2taxid> [options]
```
This will generate **diffIdx**, **info**, **split**, and **taxID_list** and some other files. You can delete '\*\_diffIdx' and '\*\_info' if generated.

---

## Example
> The example here was detecting SARS-CoV-2 variant-specific reads, but has changed since the pre-built DB no longer contains the variant genomes.
Expand Down

0 comments on commit 5cf8577

Please sign in to comment.