Skip to main content

Normalize antibiotic resistance genes (ARGs) abundance tables (e.g., from metagenomics) by using the ARO ontology (developed by CARD).

Project description

argNorm

Python package Downloads

Antibiotic resistance gene (ARG) normalization by mapping to the antibiotic resistance ontology (ARO) by CARD.

Right now, many tools exist for annotating ARGs in genomes and metagenomes. However, each tool will output in its own format. The hAMRonization package can normalize file formats, but each tool will use different names/identifiers (e.g., TetA or TETA or tet(A) or tet-A are all different ways to spell the same gene name). For a small number of isolate genomes, a human user can still quickly evaluate the outputs. However, for metagenomics, especially for large-scale projects, this becomes infeasible. Thus, argNorm normalizes the output vocabulary of these tools by mapping all tools to the same ontology (ARO).

This is a beta-quality implementation (subject to changes and some bugs may remain), but you're welcomed to try it and provide feedback.

We welcome your feedback on the Issues Page.

Supported tools

Note that CARD RGI already uses ARO, thus there is no need to use argNorm.

Installation

pip install argnorm

Basic usage

Use argnorm -h to see available options.

argnorm [tool] -i [original_annotation.tsv] -o [annotation_result_with_aro.tsv]

Examples

argnorm argsoap --mode reads -i examples/raw/args-oap.sarg.reads.tsv -o tmp
argnorm argsoap --mode reads -i examples/hamronized/args-oap.sarg.reads.tsv -o tmp --hamronized
argnorm argsoap --mode orfs -i examples/raw/args-oap.sarg.orfs.tsv -o tmp
argnorm argsoap --mode orfs -i examples/hamronized/args-oap.sarg.orfs.tsv -o tmp --hamronized

argnorm deeparg -i examples/raw/deeparg.deeparg.orfs.tsv -o tmp
argnorm deeparg -i examples/hamronized/deeparg.deeparg.orfs.tsv -o tmp --hamronized

argnorm abricate --db ncbi -i examples/raw/abricate.ncbi.tsv -o tmp
argnorm abricate --db megares -i examples/raw/abricate.megares.tsv -o tmp
argnorm abricate --db argannot -i examples/raw/abricate.argannot.tsv -o tmp

argnorm abricate --db ncbi -i examples/hamronized/abricate.ncbi.tsv -o tmp --hamronized
argnorm abricate --db megares -i examples/hamronized/abricate.megares.tsv -o tmp --hamronized
argnorm abricate --db argannot -i examples/hamronized/abricate.argannot.tsv -o tmp --hamronized
argnorm abricate --db resfinder -i examples/hamronized/abricate.resfinder.tsv -o tmp --hamronized

argnorm resfinder -i examples/raw/resfinder.resfinder.orfs.tsv -o outputs/raw/resfinder.resfinder.orfs.tsv
argnorm resfinder -i examples/raw/resfinder.resfinder.reads.tsv -o outputs/raw/resfinder.resfinder.reads.tsv

argnorm amrfinderplus -i examples/raw/amrfinderplus.ncbi.orfs.tsv -o outputs/raw/amrfinderplus.ncbi.orfs.tsv

Authors

*: current maintainer

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

argnorm-0.1.0.tar.gz (1.3 MB view details)

Uploaded Source

Built Distribution

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

argnorm-0.1.0-py3-none-any.whl (3.6 MB view details)

Uploaded Python 3

File details

Details for the file argnorm-0.1.0.tar.gz.

File metadata

  • Download URL: argnorm-0.1.0.tar.gz
  • Upload date:
  • Size: 1.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for argnorm-0.1.0.tar.gz
Algorithm Hash digest
SHA256 917ac502ca8baed6923c32eb7e955fe94dcd4cfe395a0f379e3dd5465427489f
MD5 0dbca1a93c5e9420e4d11a3fd02b8f08
BLAKE2b-256 28c2bc36bee87944056f00b7646de5e276ccfb5af6c1defaf8bf7f2f895edc04

See more details on using hashes here.

File details

Details for the file argnorm-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: argnorm-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 3.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for argnorm-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5157a8e32c5dcb2e2e89447f7f75ebef1722002049961468ea5ad23234c75d94
MD5 c5308fe48b1f9cf87ab087957a6ff188
BLAKE2b-256 6cf72b4fed2bea351b621ad9281382b31e67289a23e44ab0b181758e3aafd8fb

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 Pingdom Monitoring Sentry Error logging StatusPage Status page