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_per Rank_II_per Rank_III_per Rank_IV_per Unassessed_per 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 4.6E-02 0.0E+00 6.8E-02 7.5E-01 1.3E-01 5.4E-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
    For metagenomes, the copy number of ARGs and 16S were computed as the number of reads mapped to them divided by their gene length.
    Rank_I_per - Unassessed_per: percentage 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.7.tar.gz (92.6 MB 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.7-py3.6.egg (92.7 MB view details)

Uploaded Egg

File details

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

File metadata

  • Download URL: arg_ranker-2.7.tar.gz
  • Upload date:
  • Size: 92.6 MB
  • 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.7.tar.gz
Algorithm Hash digest
SHA256 5de85d93855975b53b6619c5834399e24887350862809ac70b2c60b8a24f2473
MD5 471fd8ce768d42a1141800c0ddc7d215
BLAKE2b-256 ee6dada32dd434b9872d567206c0381cd08bbd1e9d16f29cb8b0c424839516b9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: arg_ranker-2.7-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.7-py3.6.egg
Algorithm Hash digest
SHA256 8364c40791953a9e4814b95150bf7638c6e58fae452fa869b721ce1ef719c997
MD5 f605d4df35a3caf450add6eeb25c4522
BLAKE2b-256 1f326049058c3f88e38ccf16674a28c8818d4512781b77412814978e9f1e455c

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