Skip to main content

find antimcirobial resistance genes on genomes

Project description

ResBlaster

PYPI

 ____           ____  _           _
|  _ \ ___  ___| __ )| | __ _ ___| |_ ___ _ __
| |_) / _ \/ __|  _ \| |/ _` / __| __/ _ \ '__|
|  _ <  __/\__ \ |_) | | (_| \__ \ ||  __/ |
|_| \_\___||___/____/|_|\__,_|___/\__\___|_|

Installation

pip3 install ResBlaster

Dependency

  • BLAST+ >2.7.0
  • cvmblaster (v0.3.8)

you should add BLAST in your PATH

Blast installation

Windows

Following this tutorial: Add blast into your windows PATH

Linux/Mac

The easyest way to install blast is:

conda install -c bioconda blast

Usage

1. Initialize reference database

After finish installation, you should first initialize the reference database using following command

ResBlaster -init
Usage: ResBlaster -i <genome assemble directory> -db <reference database> -o <output_directory> -minid 90 -mincov 60 -t 4


optional arguments:
  -h, --help      show this help message and exit
  -i I            <input_path>: the PATH to the directory of assembled genome files
  -o O            <output_directory>: output PATH
  -db DB          <database>: resfinder or others, You colud check database list using -list parameter
  -minid MINID    <minimum threshold of identity>, default=90
  -mincov MINCOV  <minimum threshold of coverage>, default=60
  -list           <show database list>
  -init           <initialize the reference database>
  -t T            <number of threads>: default=8
  -store_arg_seq  save the nucleotide and amino acid sequence of find genes on genome
  -v, --version   Display version

2. Making your own database

Let's say you want to make your own database called owndb. All you need is a FASTA file of nucleotide sequences, say owndb.fsa(note: the fasta file must end with .fsa). Ideally the sequence IDs would have the format >GENE___ID___ACC___CATEGORY where GENE is the name of GENE, ID is the allele ID of GENE, ACC is an accession number of the sequence source, CATEGORY is the CATEGORY of this GENE belongs to.

Your final owndb.fsa should like this:

% head -n 1 owndb.fsa
>blaOXA-62___1___AY423074___Beta-lactam
ATGAATACGATAATCTCTCGCCGGTGGCGTGCCGGCCTGTGGCGGCGGCTGGTCGGCGCG
GTCGTCTTGCCCGCAACGCTCGCCGCCACCCCTGCGGCCTATGCGGCCGACGTGCCGAAA
GCCGCGTTGGGGCGCATCACCGAGCGCGCCGACTGGGGCAAGCTGTTCGCCGCGGAGGGC
GTGAAGGGCACGATCGTGGTGCTCGACGCACGCACGCAAACCTATCAGGCCTACGACGCC
GCACGTGCCGAGAAGCGCATGTCGCCGGCGTCGACCTACAAGATATTCAACAGCCTGCTG
GCGCTCGACTCCGGGGCGCTGGACAACGAACGCGCGATCATTCCCTGGGATGGCAAGCCG
CGACGCATCAAGAACTGGAACGCGGCGATGGACCTGAGGACCGCGTTTCGCGTGTCATGC
CTGCCCTGCTATCAGGTCGTCTCGCACAAGATCGGGCGCCGGTACGCGCAGGCGAAGCTG
AACGAGGTCGGGTATGGCAACCGCACCATTGGCGGCGCGCCGGACGCCTATTGGGTCGAC
GACAGTCTGCAGATTTCGGCGCGTGAGCAGGTGGACTTCGTGCAGCGTCTCGCGCGTGGC
ACGTTGCCGTTCTCTGCGCGCTCGCAGGACATCGTGCGCCAGATGTCGATCGTCGAAGCC
ACGCCGGACTATGTGCTTCACGGCAAGACGGGTTGGTTCGTCGACAAGAAGCCCGATATC
GGCTGGTGGGTAGGGTGGATCGAGCGCGACGGCAACATCACCAGCGTCGCGATCAACATC
GACATGCTGTCGGAGGCGGACGCCCCGAAACGGGCACGCATCGTGAAGGCGGTGCTGAAG
GACCTGAAGCTGATCTGA

Run following command will add owndb.fsa to blast database

% ResBlaster -updatebd owndb.fsa

3. Features under development

Following database are currently under development and will be available soon:

Database Description
vfdb_core The core dataset of vfdb
vfdb_full The full database of vfdb
ncbi Bacterial Antimicrobial Resistance Reference Gene Database from NCBI
resfinder ARGs from ResFinder
ssuis_sero The serotype database for Streptococcus suis
hps The serotype database for Haemophilus parasuis
lmo Listeria monocytogenes relevant genes from Pasteur Institute
...

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ResBlaster-0.3.8.tar.gz (12.6 MB view details)

Uploaded Source

Built Distribution

ResBlaster-0.3.8-py3-none-any.whl (13.9 MB view details)

Uploaded Python 3

File details

Details for the file ResBlaster-0.3.8.tar.gz.

File metadata

  • Download URL: ResBlaster-0.3.8.tar.gz
  • Upload date:
  • Size: 12.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for ResBlaster-0.3.8.tar.gz
Algorithm Hash digest
SHA256 cf47d02dc3486b178b39c932cfb389b8592cabff2d1d79a7cc511347ddf20fd2
MD5 231dd527377e24d42e4eeac08f7718df
BLAKE2b-256 9b511a5e4b135ea2197fb9886a33a36259f80e8e8b2973e4f16d79a63afc2c23

See more details on using hashes here.

File details

Details for the file ResBlaster-0.3.8-py3-none-any.whl.

File metadata

  • Download URL: ResBlaster-0.3.8-py3-none-any.whl
  • Upload date:
  • Size: 13.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for ResBlaster-0.3.8-py3-none-any.whl
Algorithm Hash digest
SHA256 1065928d2bf7d653679546a41282916d1165f401452beec2ea1ae24b3671b2d2
MD5 b86be83cbe32f508a4e7cef669e4ca34
BLAKE2b-256 325160cb4892f62082339392bbada1d3adc7c817344eb13e2e2ff0eea0380ad8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page