Skip to main content

arg_ranker

arg_ranker evaluates the risk of ARGs in genomes and metagenomes

Install

pip install arg_ranker

Please make sure to install arg_ranker >= v2.8.8

To check installed version pip show arg_ranker
To upgrade pip install arg_ranker --upgrade

Requirement

  • python 3
  • diamond: conda install -c bioconda diamond (https://github.com/bbuchfink/diamond)
  • blast+: conda install -c bioconda blast (https://ftp.ncbi.nlm.nih.gov/blast/executables/blast+/LATEST/)
  • For metagenomes:
    • kraken2: conda install -c bioconda kraken2(https://github.com/DerrickWood/kraken2/wiki)
      • to compute the abundance of ARGs as copy number of ARGs per bacterial cell (recommended)
        • download the kraken2 standard database (50 GB of disk space): kraken2-build --standard --db $KRAKENDB
          where $KRAKENDB is your preferred database name/location
        • MicrobeCensu: git clone https://github.com/snayfach/MicrobeCensus && cd MicrobeCensus && python setup.py install to estimate the average genome size for metagenomes. (https://github.com/snayfach/MicrobeCensus)
      • to compute the abundance of ARGs as copy number of ARGs per 16S
        • download the kraken2 16S database (73.2 MB of disk space): kraken2-build --db $DBNAME --special greengenes

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 (genomes only)
  • run arg_ranker -i $INPUT -kkdb $KRAKENDB (genomes/metagenomes + kraken2 standard database)
    • or run arg_ranker -i $INPUT -kkdb $KRAKENDB -kkdbtype 16S (kraken2 16S database)
  • 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. Rank_I_per - Unassessed_per: percentage of ARGs of a risk Rank
    Total_abu: total abundance of all ARGs
  2. For genomes, we output the copy number of ARGs detected in each genome.
  3. For metagenomes, we compute the abundance of ARGs as the copy number of ARGs divided by the bacterial cell number or 16S copy number in the same metagenome.
    If you downloaded the kraken2 standard database, we compute the copy number of ARGs divided by the bacterial cell number.
    If you downloaded the kraken2 16S database, we compute the copy number of ARGs divided by the 16S copy number.
    The copy number of ARGs, 16S, and bacterial cells were computed as the number of reads mapped to them divided by their gene/genome length.
  4. We compute the contribution of each ARG risk Rank as the average abundance of ARGs of a risk Rank divided by the average abundance of all ARGs
    Rank_I_risk - Unassessed_risk: the contribution of ARGs of a risk Rank
    Rank_code: a code of contribution 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 (using kraken2 standard database)

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

Zhang, AN., Gaston, J.M., Dai, C.L. et al. An omics-based framework for assessing the health risk of antimicrobial resistance genes. Nat Commun 12, 4765 (2021). https://doi.org/10.1038/s41467-021-25096-3

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-3.0.tar.gz (91.9 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-3.0-py3.6.egg (92.0 MB view details)

Uploaded Egg

File details

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

File metadata

  • Download URL: arg_ranker-3.0.tar.gz
  • Upload date:
  • Size: 91.9 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.10

File hashes

Hashes for arg_ranker-3.0.tar.gz
Algorithm Hash digest
SHA256 a626fecc954ec6aaacdef5a2dd41ff4941b686e3d764b815d931a99ca41272fb
MD5 19eaf62befcfd0800da78b94e97630ed
BLAKE2b-256 9f884fb8cecfbe9fa8bd8d1e4d180fd613df92286a1cde8f7f39f574b2dd2ea7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: arg_ranker-3.0-py3.6.egg
  • Upload date:
  • Size: 92.0 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.10

File hashes

Hashes for arg_ranker-3.0-py3.6.egg
Algorithm Hash digest
SHA256 0d607bc9b3dfc9d25b2db9f2f8b76de61543288e7c80d425a01ee30897a34c64
MD5 8e921339276e84680f87df2e8f27b078
BLAKE2b-256 871572dcd6345accf8fdd3441f9f16d4815e49cf5a79b73061389a3bc439b30b

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