Skip to main content

A Python tool for panresistome analysis

Project description

PanR: Panresistome Analysis Tool

Overview

PanR is a Python-based tool for analyzing panresistome data. It processes NCBI and Abricate summary files, merges the data, and generates visualizations such as lollipop plots, bar plots, and heatmaps. The tool is designed to help researchers analyze and visualize gene presence and prevalence across different geographic locations. It requires ncbi_clean.csv from FetchM and summary files in .tab (preferred) or .csv format from Abricate.

Key Features:

  • Merges and processes NCBI and Abricate data.
  • Analyzes gene presence across samples.
  • Generates visualizations for resistance gene distributions/prevalence.

Installation

Using pip

pip install panR

Using conda

conda create -n panr_env python=3.8
conda activate panr_env
pip install git+https://github.com/Tasnimul-Arabi-Anik/PanR.git

From GitHub (Manual Installation)

git clone https://github.com/Tasnimul-Arabi-Anik/PanR.git
cd PanR
pip install -r requirements.txt

Usage

Command-Line Arguments

panR --ncbi_dir <NCBI_DIRECTORY> --abricate-dir <ABRICATE_DIRECTORY> --output-dir <OUTPUT_DIRECTORY> --fig-format <FIGURE_FORMAT>

Arguments

Argument Description
--ncbi-dir Path to ncbi_clean.csv file.
--abricate-dir Directory containing Abricate summary .tab or .csv files.
--output-dir Directory to store merged results and visualizations.
--format Output format for figures (png, pdf, tiff,svg).

Example Run

panR --ncbi-dir ./data/ncbi_clean.csv --abricate-dir ./data/abricate --output-dir ./output --format png

Outputs

  • Processed Data: Saved in output/ directory as .csv.
  • Visualizations:
    • Heatmap of resistance genes across samples. figure1
    • Bar plot showing gene presence. figure3
    • lolipoplot showing gene counts figure2

License

This tool is provided under the MIT License.

Author

Tasnimul Arabi Anik

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

panr-0.1.0.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

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

panr-0.1.0-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: panr-0.1.0.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for panr-0.1.0.tar.gz
Algorithm Hash digest
SHA256 9af3b13bc407c39a25fef88f0424040dfa55bd594f54a5dc1f2ed24e114fd39f
MD5 87a383200fc514b41626a6b0bf5ecf03
BLAKE2b-256 13956e84801262ce9aa9e33f5af1d87fdbe72d085dbed085d7dffa0e90e010c0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: panr-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for panr-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fd2370c8e5cd4cba7acd954810a422c6713f239113719b85c0ba6efe27a05744
MD5 13acec86aa12bc71ea10ae88f6b2d489
BLAKE2b-256 519f5b549f298c4e57f3f0ed0d23a61c1ec56f213c072fae445c9a5ad738ceb3

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