Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Robaina committed May 19, 2023
1 parent 4a03e6e commit 7e44b54
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

---
## :bulb: What is MetaTag?
This repository contains tools to assign taxonomy and function annotations to short reads through pylogenetic tree evolutionary placement
This repository contains tools to assign taxonomy and function annotations to short reads through pylogenetic tree evolutionary placement.

## :wrench: Setup
The easiest way to use MetaTag is through the provided [docker](https://www.docker.com/) container. To use it, pull the image:
Expand Down Expand Up @@ -51,6 +51,13 @@ To check that everything is working properly, you can run a test what will perfo
conda activate metatag
(metatag) bash tests/run_test.sh
```

or through Python's unittest module:
```bash
conda activate metatag
(metatag) python -m unittest tests/test_pipeline.py
```

It should produce a final tree with query sequences placed on it, as well as a bunch of intermediary files without any errors.

## :rocket: Usage
Expand Down

0 comments on commit 7e44b54

Please sign in to comment.