Metadata-Version: 2.4
Name: polargini
Version: 1.0.0
Summary: Python implementation of the Polar Gini Curve
Author-email: Thanh Minh Nguyen <thamnguy@uab.edu>, Zhandos Sembay <zsembay8@uab.edu>
Maintainer-email: Zeyu Yao <cytronicoder@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/cytronicoder/polar-gini-curve
Project-URL: Repository, https://github.com/cytronicoder/polar-gini-curve
Project-URL: Issues, https://github.com/cytronicoder/polar-gini-curve/issues
Keywords: gini,spatial,single-cell,rna-seq
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.20
Requires-Dist: pandas>=1.1
Provides-Extra: plot
Requires-Dist: matplotlib>=3.3; extra == "plot"
Requires-Dist: seaborn>=0.11; extra == "plot"
Provides-Extra: io
Requires-Dist: scipy>=1.5; extra == "io"
Provides-Extra: legacy
Requires-Dist: scipy>=1.5; extra == "legacy"
Requires-Dist: h5py>=3.0; extra == "legacy"
Requires-Dist: openpyxl>=3.0; extra == "legacy"
Provides-Extra: dev
Requires-Dist: pytest>=6; extra == "dev"
Requires-Dist: pytest-cov>=3; extra == "dev"
Requires-Dist: ruff>=0.1.0; extra == "dev"
Requires-Dist: black>=23.1.0; extra == "dev"
Requires-Dist: mypy>=1.0; extra == "dev"
Requires-Dist: matplotlib>=3.3; extra == "dev"
Requires-Dist: scipy>=1.5; extra == "dev"
Requires-Dist: h5py>=3.0; extra == "dev"
Requires-Dist: openpyxl>=3.0; extra == "dev"
Dynamic: license-file

# Python Polar Gini Curve

[![PyPI version](https://badge.fury.io/py/polargini.svg)](https://pypi.org/project/polargini/)
[![CI](https://github.com/cytronicoder/polar-gini-curve/actions/workflows/ci.yml/badge.svg)](https://github.com/cytronicoder/polar-gini-curve/actions/workflows/ci.yml)

This is a Python port of the Polar Gini Curve introduced by Nguyen et al. (2021). I've implemented the core functionality in Python, making it easier to integrate into Python-based data analysis workflows. The original MATLAB code is available in the [aimed-lab/Polar-Gini-Curve repository](https://github.com/aimed-lab/Polar-Gini-Curve).

## Quickstart

To get started with the Polar Gini Curve in Python, you can install the package from PyPI, then use the CLI to compute the Polar Gini Curve from a CSV file containing your data. Here's a quick example:

```bash
pip install polargini
pgc --csv data.csv --plot
```

For more detailed usage, refer to the [original documentation](https://github.com/aimed-lab/Polar-Gini-Curve/blob/main/README.md).

## Citation

Nguyen, T.M., Jeevan, J.J., Xu, N. and Chen, J.Y., "Polar Gini Curve: a technique to discover gene expression spatial patterns from single-cell RNA-seq data," _Genomics, Proteomics & Bioinformatics_ 19(3), 493-503 (2021).
