Code Monkey home page Code Monkey logo

toxiper's Introduction

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.

Dependencies

Usage

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

$ TOXIper.sh -h

This bash script assigns toxinotypes to C. perfringens genome assemblies using ABRicate v1.0.1 (type will be shown on stdout)
Dependency: ABRicate v1.0.1 with toxinCP database

Usage: ./TOXIper.sh [options] FASTAFILE
Option:
 -h print usage and exit
 -a print author and exit
 -v print version and exit

Version 1.1
Author: Raymond Kiu [email protected] (2020)

Input - genome assemnbly

A C. perfringens genome assembly in multi-fasta format. One at a time. To give you an idea what a multi-fasta format is:

>Contig1
ATTCGCGAAAGGCCCCCCTTTG
ATGGGGTGTGCCCCCGGTGTGT

It will not work on bugs other than C. perfringens as genes will not be detected.

To analyse a genome assembly

Toxinotype (e.g. B) will be printed on the stdout

$ TOXIper.sh CP-21.fna 
B

ABRicate BLASTn cutoffs will be set at default, which is minimum nucleotide identity >80% and minimum coverage >80%.

To save outcome into a file

Use > to save outcome into a new file, for example (can be any file name you like)

$ TOXIper.sh CP-21.fna > CP-21.toxinotype

License

GPLv3

Issues

Please report bugs at the issues page so I can respond.

Citation

  • Please cite this paper if you used the toxin sequence database for toxinotyping.
  • Also cite ABRicate as a dependency.

If you use TOXIper for results in your publication, please cite:

  • Kiu R, TOXIper: rapid toxinotyping of Clostridium perfringens genomes, GitHub https://github.com/raymondkiu/TOXIper

Author

Raymond Kiu [email protected]

toxiper's People

Stargazers

 avatar

Watchers

 avatar  avatar

Forkers

zarrinbasharat

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.