Skip to main content

GWAS Association Tools

Project description

GWAS Association Tools

A command-line tool for genomic-wide association studies (GWAS) data validation and analysis.

Features

  • Validate:
    • Input: File path of GWAS Submission template that contains top associations
    • Output: Validation report of top associations

Installation

Install from PyPI:

pip install gwas-assoc-tools

Usage

# Basic validation command
gwas-assoc validate <template excel file path>

# For help
gwas-assoc --help
gwas-assoc validate --help

Development

Setup

# Install Poetry (if not already installed)
curl -sSL https://install.python-poetry.org | python3 -

# Install dependencies
poetry install

# Activate virtual environment
poetry shell

Building and Installation

# Build the package (creates .whl and .tar.gz in dist/)
poetry build

# Install your new package in development mode
poetry install

Testing

TODO

Running with Real Files

# Run the CLI command through Poetry
# For failed test file
poetry run gwas-assoc validate ./tests/test_fail.xlsx   
# For successful test file
poetry run gwas-assoc validate ./tests/test_success.xlsx   


# Or after activating the shell
poetry shell
# For failed test file
gwas-assoc validate ./tests/test_fail.xlsx   
# For successful test file
gwas-assoc validate ./tests/test_success.xlsx   

Dependency Management

# Add a new dependency
poetry add new-package

# Add a development dependency
poetry add --group dev pytest-mock

# Check for dependency updates
poetry update --dry-run

# Update dependencies
poetry update

Code Quality

# Run formatting
poetry run black .
poetry run isort .

# Run linting
poetry run ruff check .

# Run type checking
poetry run mypy src

# Run all formatting checks
poetry run pre-commit run --all-files

License

License

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

gwas_assoc_tools-0.1.2b3.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

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

gwas_assoc_tools-0.1.2b3-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

File details

Details for the file gwas_assoc_tools-0.1.2b3.tar.gz.

File metadata

  • Download URL: gwas_assoc_tools-0.1.2b3.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.10.16 Linux/5.14.0-503.22.1.el9_5.x86_64

File hashes

Hashes for gwas_assoc_tools-0.1.2b3.tar.gz
Algorithm Hash digest
SHA256 ff01b941236c86a1059d41a9d5274b7eca68a10ac93b248f8d70408dffe057b5
MD5 ee7a4ecb7dc8903c9c8cc7d2000551ea
BLAKE2b-256 ae735dad8617040392f6cbd06cd513a93fec27b780a568fc3234cd3d25632e8d

See more details on using hashes here.

File details

Details for the file gwas_assoc_tools-0.1.2b3-py3-none-any.whl.

File metadata

  • Download URL: gwas_assoc_tools-0.1.2b3-py3-none-any.whl
  • Upload date:
  • Size: 14.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.10.16 Linux/5.14.0-503.22.1.el9_5.x86_64

File hashes

Hashes for gwas_assoc_tools-0.1.2b3-py3-none-any.whl
Algorithm Hash digest
SHA256 66aa0edbbaa645ae629d2e7608a50f7c133f6e01ff8bf4cad374d91e5180070b
MD5 d1a4a9fc5c74e7026660cc56f3a8b820
BLAKE2b-256 285c826b0f288f7e6d9d23777f7b43a6d17d4d297cde048d150ba9dc72894726

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