# Collection Of Data Mining Algorithms (CODMA)

[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)

## What is this?

This is the collection of our algorithm and its modules for data analyses

## List of Algorithms

| Name of Algorithm | Author |
| ------------- | ------------- |
| kmeansMkI.py  | [Tillmann](https://github.com/tchemn) and [Conrad](https://github.com/creyd) |
| [ PENDING ]  | [ PENDING ]  |

## List of Modules

| Name of Module | Author | Discription | Path |
| ------------- | ------------- | ------------- | ------------- |
| randomI.py  | [Tillmann](https://github.com/tchemn) and [Conrad](https://github.com/creyd) | Random data generator | src\data_generators\randomi.py |
| importer.py  | [Tillmann](https://github.com/tchemn) and [Conrad](https://github.com/creyd) | Importer for the algorithm | src\modules\importer.py |

## How to contribute

1. Write your algorithm (or part of it)
2. Choose a neat name for it (NAME in the following)
3. Fork this repository (or with rights: add a branch `alg_NAME`)
4. Create subfolder `src/algorithms/NAME`
5. Add your algorithm to the `menu`-script in the `algorithm`-folder 
6. Add your algorithm to the list above in the following format `NAME | Author`
7. Create a `HowToUse`-file in your main folder
**Only if your algorithm works:**
8. Create a pull request to merge the data

**Pay attention: NEVER commit test data, passwords or personal information!**

Have fun... :)

~