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.1.tar.gz (6.8 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.1-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: panr-0.1.1.tar.gz
  • Upload date:
  • Size: 6.8 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.1.tar.gz
Algorithm Hash digest
SHA256 1406f00827f4dff484c4a7e766e2813d73edaa374b2fe60ae7a21ea0b753e5a3
MD5 6e18ccd830f7785522643d00ade95ffa
BLAKE2b-256 02c96795bae7ec8f45bf79110c4537153873590a5043264c1f6deec874480585

See more details on using hashes here.

File details

Details for the file PanR-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: PanR-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 6.9 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8c62d3f7d938ee152c8fb411c25598286e7f0b111c9425cc5ff1368af2dea5c1
MD5 4fc81b7eceba31a792da29524d27ea8c
BLAKE2b-256 a5352c1735fbe43118bc2a43eda4574dbd78d984aa54c8f5f820ffb56781f45d

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