Skip to main content

Add your description here

Project description

ATGtools

Supported Python Versions PyPI version

This is a collection of tools for NGS data analysis. It provides many easy-to-use functionalities to clean, visualize, and analyze NGS results.

Installation

Latest atgtools version: PyPI version

Recommended Installation Methods

Using pipx (Recommended)

pipx installs Python applications in isolated environments:

pipx install atgtools

Using uv (Alternative)

uv pip install atgtools

Development Setup

For development, clone the repository and set up the environment using uv:

# Clone the repository
git clone https://github.com/yourusername/atgtools.git
cd atgtools

# Create and activate virtual environment with Python 3.12
uv venv --python 3.12
source .venv/bin/activate  # On Unix/macOS

# Install dependencies
uv sync

# Use as a module
python -m atg --help

Features

Diversity Analysis

The package provides tools for both alpha and beta diversity analysis.

Alpha Diversity

Calculate various alpha diversity indices:

  • Shannon (natural log and custom base)
  • Gini-Simpson
  • Simpson
  • Dominance
  • Richness
  • Pielou's Evenness
atg div alpha --input abundance.tsv

Beta Diversity

Calculate dissimilarity between samples using various metrics:

  • Bray-Curtis
  • Jensen-Shannon
  • Jaccard
  • Euclidean
  • UniFrac (weighted and unweighted)
atg div beta --input abundance.tsv --metric braycurtis

Utility Tools

Git Repository Management

Check multiple git repositories in one pass:

atg tools git [options]

Options:

  • --verbose/-v: Show files & commits
  • --remote/-r: Force remote update
  • --untracked/-u: Show untracked files
  • --dir/-d: Search specific directory for repositories
  • --all-branch/-a: Show status of all branches
  • --stash/-s: Show stashed changes

Manifest Creation

Create manifest files for QIIME2:

atg tools manifest --fastq_dir /path/to/fastq --output manifest.tsv

Supported FASTQ naming schemes:

  • sample_R1.fastq.gz
  • sample_R2.fastq.gz
  • sample_S01_R1.fastq.gz
  • sample_S01_R2.fastq.gz

Other Tools

  • atg tools oneliner: Convert multiline FASTA to single line
  • atg tools countfq: Count reads in FASTQ files
  • atg tools abundance: Generate relative abundance tables
  • atg tools download: Download ENA data
  • atg tools retrieve: Search and retrieve ENA data
  • atg tools search: Search ENA database

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

atgtools-0.1.9rc0.tar.gz (73.1 kB view details)

Uploaded Source

Built Distribution

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

atgtools-0.1.9rc0-py3-none-any.whl (90.6 kB view details)

Uploaded Python 3

File details

Details for the file atgtools-0.1.9rc0.tar.gz.

File metadata

  • Download URL: atgtools-0.1.9rc0.tar.gz
  • Upload date:
  • Size: 73.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.1

File hashes

Hashes for atgtools-0.1.9rc0.tar.gz
Algorithm Hash digest
SHA256 52327139ebfa9f09c4ecbc041d468e387fe83c4ee1d76477b2e4314841a6291c
MD5 a65e6cb3709bc18d47898892a94a6231
BLAKE2b-256 70e9546d5267d33202497d1b8b87313087d178d6a76718f5f41439415e0fbec4

See more details on using hashes here.

File details

Details for the file atgtools-0.1.9rc0-py3-none-any.whl.

File metadata

File hashes

Hashes for atgtools-0.1.9rc0-py3-none-any.whl
Algorithm Hash digest
SHA256 f9a8dfe8714b90d4be55b11e43dd8a8d43978d56a7731ff4aae556ed53a0c6e0
MD5 a985736ff4de19f79a785ed17c784fd5
BLAKE2b-256 dd4ea3ba57c899e5ab616851e8089b242759167b75b5c1f58fd2f682843f49ab

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