Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Raymond Kiu authored May 20, 2020
1 parent 976eded commit 01f2eb4
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# TOXIper
Toxinotype assignment of *Clostridium perfringens* via ABRicate. *C. perfringens* has 7 toxinotypes (i.e. A-G) based on the different combinations of toxin genes. A validated/published toxin gene database is included in this repository.
Toxinotype assignment of *Clostridium perfringens* via ABRicate. *C. perfringens* has 7 toxinotypes (i.e. A-G) based on the different combinations of toxin genes. A validated/published [toxin gene database](https://github.com/raymondkiu/TOXIper/blob/master/sequences) is included in this repository.

## Dependencies
* ABRicate v1.0.1 (https://github.com/tseemann/abricate/tree/v1.0.1) and its dependencies (will be available using Conda)
* [ABRicate v1.0.1](https://github.com/tseemann/abricate/tree/v1.0.1) and its dependencies (will be available using Conda)

## Usage
To trigger help/usage option
### Set up ABRicate database for *C. perfringens toxin genes*
Please refer to this section in ABRicate github page: https://github.com/tseemann/abricate#making-your-own-database

### Help option
```
Expand Down

0 comments on commit 01f2eb4

Please sign in to comment.