https://github.com/sodascience/remode
Finding modes in discrete distributions
https://github.com/sodascience/remode
modality mode-detection ordinal-data
Last synced: about 1 year ago
JSON representation
Finding modes in discrete distributions
- Host: GitHub
- URL: https://github.com/sodascience/remode
- Owner: sodascience
- License: mit
- Created: 2024-04-25T18:05:15.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-03T20:19:16.000Z (almost 2 years ago)
- Last Synced: 2025-01-25T12:09:35.380Z (over 1 year ago)
- Topics: modality, mode-detection, ordinal-data
- Language: Jupyter Notebook
- Homepage:
- Size: 576 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# ReMoDe
`ReMoDe` is a Python library designed for the robust detection of modes in data distributions. It uses statistical tests, including Fisher's exact test and binomial tests, to determine if a given maximum in a data distribution is a true local maximum.
### Features
- Mode Detection: Identifies all potential local maxima in the dataset.
- Statistical Tests: Implements Fisher's exact test and binomial tests to validate modes.
- Data Formatting: Converts raw data into histogram format for analysis.
- Stability Analysis: Includes functionality to assess the stability of detected modes using jackknife resampling.
- Visualization: Provides methods to plot the histogram of data along with identified modes.
### Installation
```bash
pip install git+https://git@github.com/sodascience/remode.git@main
```
### Usage
Here is a simple example of how to use the ReMode library:
```python
from remode import ReMoDe
# Sample data (histogram counts)
xt_count = [8, 20, 5, 2, 6, 2, 30]
# Create an instance of ReMoDe
detector = ReMoDe()
# Fit model
results = detector.fit(xt_count)
# Plot the results
detector.plot_maxima()
# Perform stability analysis
stability_info = detector.evaluate_stability(percentage_steps=50)
```
### Citation
Please cite the following paper
```
To be added
```
### Contributing
Contributions are what make the open source community an amazing place
to learn, inspire, and create. Any contributions you make are **greatly
appreciated**.
Please refer to the
[CONTRIBUTING](https://github.com/sodascience/remode/blob/main/CONTRIBUTING.md)
file for more information on issues and pull requests.
### License
This project is licensed under the GNU GPLv3. This allows you to do almost anything they want with this project, except distributing closed source versions.
## Contact
This project is a port of the R version of [`ReMoDe`](https://github.com/hvdmaas/remode). It is maintained by the [ODISSEI Social Data
Science (SoDa)](https://odissei-data.nl/nl/soda/) team.
Do you have questions, suggestions, or remarks? File an issue in the issue
tracker!