Skip to main content

arg_ranker

arg_ranker evaluates the risk of ARGs in genomes and metagenomes

Install

pip install arg_ranker

Requirement

  • python 3
  • kraken2: conda install -c bioconda kraken2
    download kraken2 database: kraken2-build --standard --db $KRAKENDB
    where $krakenDB is your preferred database name/location\
  • diamond: conda install -c bioconda diamond\
  • blast+: conda install -c bioconda blast

How to use it

  • put all your genomes (.fa or .fasta) and metagenomes (.fq or .fastq) into one folder ($INPUT)
  • run arg_ranker -i $INPUT --kkdb $KRAKENDB
  • run sh arg_ranking/script_output/arg_ranker.sh

Output

  • Sample_ranking_results.txt (Table 1)

    Sample Rank_I_abu Rank_II_abu Rank_III_abu Rank_IV_abu Unassessed_abu Total_abu Rank_code Rank_I_risk Rank_II_risk Rank_III_risk Rank_IV_risk ARGs_unassessed_risk note1
    WEE300_all-trimmed-decont_1.fastq 2.9E-02 0.0E+00 7.4E-02 7.8E-01 1.2E-01 4.2E-04 1.0-0.0-0.5-1.7-0.3 1.0 0.0 0.5 1.7 0.3 hospital_metagenome
    EsCo_genome.fasta 0.0E+00 0.0E+00 0.0E+00 1.0E+00 0.0E+00 2.0E+00 0.0-0.0-0.0-2.2-0.0 0.0 0.0 0.0 2.2 0.0 E.coli_genome
  1. We compute the abundance of ARGs as the copy number of ARGs divided by the 16S copy number in a sample
    Rank_I - Unassessed_abu: total abundance of ARGs of a risk rank
    Total_abu: total abundance of all ARGs
  2. We compute the risk of ARGs as the average abundance of ARGs of a risk rank divided the average abundance of all ARGs
    Rank_I_risk - Unassessed_risk: the risk of ARGs of a risk rank
    Rank_code: a code of ARG risk from Rank I to Unassessed
  • Sample_ARGpresence.txt:
    The abundance, the gene family, and the antibiotic of resistance of ARGs detected in the input samples

Test

run arg_ranker -i example --kkdb $KRAKENDB
run sh arg_ranking/script_output/arg_ranker.sh
The arg_ranking/Sample_ranking_results.txt should look like Table 1

Metadata for your samples (optional)

arg_ranker can merge your sample metadata into the results of ARG ranking (i.e. note1 in Table 1).
Simply put all information you would like to include into a tab-delimited table
Make sure that your sample names are listed as the first column (check example/metadata.txt).

Copyright

Dr. An-Ni Zhang (MIT), Prof. Eric Alm (MIT), Prof. Tong Zhang* (University of Hong Kong)

Citation

  1. Zhang AN, ..., Alm EJ, Zhang T: Choosing Your Battles: Which Resistance Genes Warrant Global Action? (bioRxiv coming soon)
  2. Yang Y, ..., Tiedje JM, Zhang T: ARGs-OAP: online analysis pipeline for antibiotic resistance genes detection from metagenomic data using an integrated structured ARG-database. Bioinformatics 2016.

Contact

anniz44@mit.edu or caozhichongchong@gmail.com

Download files

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

Source Distribution

arg_ranker-2.4.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

arg_ranker-2.4-py3.6.egg (92.7 MB view details)

Uploaded Egg

File details

Details for the file arg_ranker-2.4.tar.gz.

File metadata

  • Download URL: arg_ranker-2.4.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.8.0 tqdm/4.32.2 CPython/3.6.7

File hashes

Hashes for arg_ranker-2.4.tar.gz
Algorithm Hash digest
SHA256 768c7792b6e40e1318749c62bd2868bb2fc06dd90f1722e9146788a45791c5d7
MD5 4b04aca20f4b01033fd234320c40dcbf
BLAKE2b-256 c5aa9f82566ed7ea2719638990c05dae7be62ecc7fe1ecc6e840a3e00974ad65

See more details on using hashes here.

File details

Details for the file arg_ranker-2.4-py3.6.egg.

File metadata

  • Download URL: arg_ranker-2.4-py3.6.egg
  • Upload date:
  • Size: 92.7 MB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.8.0 tqdm/4.32.2 CPython/3.6.7

File hashes

Hashes for arg_ranker-2.4-py3.6.egg
Algorithm Hash digest
SHA256 1e803f7c3a90f2b3a3e1c16cc0ebc0e7c58dbf18752b44880726eccdbeae42f2
MD5 a61f4333f20c4340020094bc244aaeeb
BLAKE2b-256 7deeb2fb8aedbc938999f282ce32619f562340a01d5745d4e2a77dedd9bed4da

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page