Metadata-Version: 2.1
Name: pyCellPhenoX
Version: 0.1.4
Summary: An eXplainable Cell-specific machine learning method to predict clinical Phenotypes using single-cell multi-omics
Home-page: https://pyCellPhenoX.readthedocs.io/
License: MIT
Author: Fan Zhang
Maintainer: Revanth Krishna
Maintainer-email: revanth.krishna@cuanschutz.edu
Requires-Python: >=3.12,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: matplotlib (>=3.9.2,<4.0.0)
Requires-Dist: numba (>=0.60.0,<0.61.0)
Requires-Dist: numpy (>=2.0,<3.0)
Requires-Dist: pandas (>=2.2.3,<3.0.0)
Requires-Dist: scikit-learn (>=1.5.2,<2.0.0)
Requires-Dist: shap (>=0.46.0,<0.47.0)
Requires-Dist: statsmodels (>=0.14.3,<0.15.0)
Requires-Dist: xgboost (>=2.1.1,<3.0.0)
Project-URL: Repository, https://github.com/fanzhanglab/pyCellPhenoX
Description-Content-Type: text/markdown

<img width="40%" align = "right" src="https://github.com/fanzhanglab/pyCellPhenoX/blob/main-clone/logo/pycpx.png">
</br>
</br>
</br>
</br>
</br>
</br>
</br>

# pyCellPhenoX 

<!-- badges: start -->
<!-- [![PyPI](https://img.shields.io/pypi/v/pyCellPhenoX.svg)][pypi_]
[![Status](https://img.shields.io/pypi/status/pyCellPhenoX.svg)][status]
[![Python Version](https://img.shields.io/pypi/pyversions/pyCellPhenoX)][python version]
[![License](https://img.shields.io/pypi/l/pyCellPhenoX)][license]

[![Read the documentation at https://pyCellPhenoX.readthedocs.io/](https://img.shields.io/readthedocs/pyCellPhenoX/latest.svg?label=Read%20the%20Docs)][read the docs]
[![Tests](https://github.com/fanzhanglab/pyCellPhenoX/workflows/Tests/badge.svg)][tests]
[![Codecov](https://codecov.io/gh/fanzhanglab/pyCellPhenoX/branch/main/graph/badge.svg)][codecov]

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]

[pypi_]: https://pypi.org/project/pyCellPhenoX/
[status]: https://pypi.org/project/pyCellPhenoX/
[python version]: https://pypi.org/project/pyCellPhenoX
[read the docs]: https://pyCellPhenoX.readthedocs.io/
[tests]: https://github.com/fanzhanglab/pyCellPhenoX/actions?workflow=Tests
[codecov]: https://app.codecov.io/gh/fanzhanglab/pyCellPhenoX
[pre-commit]: https://github.com/pre-commit/pre-commit
[black]: https://github.com/psf/black -->

<!-- badges: end -->
<p align="justify">
We introduce pyCellPhenoX, ____________________________ </br>
_____________________________________________________ </br>
_____________________________________________________ </br>
</p>

</br>

<img width="100%" align = "center" src="https://github.com/fanzhanglab/pyCellPhenoX/blob/main-clone/media/CellPhenoX.png">

</br>
</br>
</br>



## Installation

You can install _pyCellPhenoX_ using [pip] from [PyPI]:

```bash
$ pip install pyCellPhenoX
```

### Dependencies/ Requirements

```python
python = "^3.12"
pandas = "^2.2.3"
numpy = "^2.1.1"
xgboost = "^2.1.1"
shap = "^0.46.0"
scikit-learn = "^1.5.2"
matplotlib = "^3.9.2"
statsmodels = "^0.14.3"
```

</br>

## Tutorials

Please see the [Command-line Reference] for details.


</br>

## API

- TODO
</br>

## Usage

- TODO
</br>

## License

Distributed under the terms of the [MIT license][license],
_pyCellPhenoX_ is free and open source software.

</br>


## Code of Conduct

- TODO
</br>

## Contributing

- TODO
## Issues

If you encounter any problems,
please [file an issue] along with a detailed description.
</br>

## Citation

- TODO
</br>

## Contact
Please contact [fanzhanglab@gmail.com](fanzhanglab@gmail.com) for
further questions or protential collaborative opportunities!
<!-- github-only -->


[license]: https://github.com/fanzhanglab/pyCellPhenoX/blob/main/LICENSE
[contributor guide]: https://github.com/fanzhanglab/pyCellPhenoX/blob/main/CONTRIBUTING.md
[command-line reference]: https://pyCellPhenoX.readthedocs.io/en/latest/usage.html

