https://github.com/grindelfp/data-whale
This project is a simple data analise library with a simple JavaFX GUI.
https://github.com/grindelfp/data-whale
Last synced: 11 months ago
JSON representation
This project is a simple data analise library with a simple JavaFX GUI.
- Host: GitHub
- URL: https://github.com/grindelfp/data-whale
- Owner: GrindelfP
- License: mit
- Created: 2023-10-20T20:47:09.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-20T21:48:31.000Z (over 2 years ago)
- Last Synced: 2025-02-01T11:42:47.003Z (over 1 year ago)
- Language: Kotlin
- Size: 102 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.adoc
- License: LICENSE
Awesome Lists containing this project
README
= Data Whale Project =
== Description ==
This project is a simple data analise library with a simple JavaFX GUI. The library can be used standalone or with provided GUI. The library works with data zipped in .zip archives.
The license of this project is available in link:LICENSE[] file. Shortly, it is the MIT license, which allows you to use this project in any way you want, except for claiming it as your own.
== How to use (GUI edition) [needs updates] ==
If you want to use GUI of DataWhale follow these steps:
1. Download and run the application
2. Provide absolute path to the archive with data (if the data is stored not in an archive check the checkbox "Data is not zipped").
3. Click "Proceed" button
4. You will be presented with dataset analysis results, which will return user the top entries by each column.
NOTE: The table can be divided into different files, but they must be in the same directory. The tables in the files should contain the same entry headers but can contain different columns. All of these will be merged by entry headers.
NOTE: The data files should be in .csv format.
== How to use (as programmer) [needs updates] ==
1. Download the library
2. Add the library to your project, but placing its package in your project's package
3. Use the filemanager and datawhale packages to work with library.
The exact ways to use the library you can learn from the <> section below.
NOTE: If your data is stored in a single .csv file, you can skip using the filemanager package of the library and use the datawhale directly. Also, you can use your own code to transcribe the data into the .csv format and then use the library.
== Documentation of the library [TODO] [[documentation, documentation]] ==
=== Library [TODO] ===
=== GUI [TODO] ===