Metadata-Version: 2.1
Name: subgroups
Version: 0.1.6
Summary: subgroups is a python library which contains a collection of subgroup discovery algorithms and other data analysis utilities
Home-page: https://github.com/antoniolopezmc/subgroups
Author: Antonio López Martínez-Carrasco
Author-email: antoniolopezmc1995@gmail.com
Maintainer: Antonio López Martínez-Carrasco
Maintainer-email: antoniolopezmc1995@gmail.com
License: BSD-3-Clause
Keywords: python,data-science,machine-learning,data-analysis,subgroups,subgroup-discovery
Platform: any
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas>=2.0.3
Requires-Dist: bitarray>=2.7.6
Requires-Dist: statsmodels>=0.14.0

[![PyPI - Version](https://img.shields.io/pypi/v/subgroups)](https://pypi.org/project/subgroups/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/subgroups)](https://pypi.org/project/subgroups/) [![PyPI - License](https://img.shields.io/pypi/l/subgroups)](https://pypi.org/project/subgroups/) ![Pepy Total Downlods](https://img.shields.io/pepy/dt/subgroups)
 [![GitHub Repo stars](https://img.shields.io/github/stars/antoniolopezmc/subgroups)](https://github.com/antoniolopezmc/subgroups)

# subgroups

**subgroups** is a Python library that provides a collection of subgroup discovery algorithms and other data analysis utilities.

## Installation

The source code is currently hosted on: https://github.com/antoniolopezmc/subgroups

To install the 'subgroups' library from pip, it is necessary to execute:

```sh
pip install subgroups
```

## Testing

After installing the library, a collection of tests can be launched by executing:

```python
import subgroups.tests as st
st.run_all_tests()
```

## Documentation

The official documentation is hosted on https://antoniolopezmc.github.io/subgroups-docs/

## Manually generating the documentation

To manually generate the library documentation, it is necessary to execute:

```sh
# 1. Clone the repository.
git clone https://github.com/antoniolopezmc/subgroups.git
# 2. Go to the 'docs' subfolder.
cd subgroups/docs
# 3. Generate the documentation.
make build
```

The generated documentation will be located in the *build* subfolder.
