44
55** Tested on:** Windows (10/11), Linux (Pop!_ OS), and macOS (Sonoma).
66
7+ To get started quickly, please see the [ Getting Started] ( #getting-started ) section, method 3.
8+
79## Analyzing Fisher Iris Benchmark Dataset
810
911Below are screenshots showcasing the exploration of the Fisher Iris dataset, which serves as a benchmark.
@@ -152,7 +154,7 @@ This transformation can provide deeper insights and improve classification.
152154
153155## Getting Started
154156
155- There are multiple ways to run JTabViz, we suggest skipping to method 3 and utilizing the multiplatform scripts (does require a Java compiler).
157+ There are multiple ways to run JTabViz, but we suggest using method 3 for simplicity and cross-platform compatibility (requires a Java compiler).
156158
1571591 . ** Using the Pre-Compiled JAR File:**
158160 - Download the ` JTabViz.jar ` file and the ` libs ` folder.
@@ -187,32 +189,38 @@ There are multiple ways to run JTabViz, we suggest skipping to method 3 and util
187189
1881903. ** Using the Provided Scripts:**
189191 - Run the appropriate script for your operating system to compile and execute the application in one step:
190- - ** macOS/Linux:** ` compile_and_run_jtabviz.sh`
191- - ** Windows:** ` compile_and_run_jtabviz.bat`
192+ - ** macOS/Linux:** ` compile_and_run_mac_linux.sh`
193+ - ** Windows:** ` compile_and_run_windows.bat`
194+
195+ to compile, package, and execute the new jar in one step:
196+ - ** macOS/Linux:** ` compile_and_package_mac_linux.sh`
197+ - ** Windows:** to be added shortly.
192198
193- # # Data Format
199+ # # Dataset File Format
194200
195- JTabViz accepts data in CSV (Comma-Separated Values) format. Here are the key points about the expected data format:
201+ JTabViz accepts datasets in CSV (Comma-Separated Values) file format. Here are the key points about the expected data format:
196202
197- 1. File Extension: The data file should have a .csv extension.
203+ 1. File Extension: The data file should have a * .csv* extension.
198204
1992052. Data Types:
200206 - Numerical data is preferred for optimal visualization and analysis.
201- - Non-numerical data and blank fields are also accepted.
207+ - Non-numerical (categorical) data and blank fields are also accepted.
202208
2032093. Class Column:
204210 - A column representing the class or category of each data point is expected.
205211 - This column can appear in any position.
206- - Should be titled ' class' (case-insensitive, so ' Class' or ' CLASS' are also acceptable).
212+ - Should be titled * ' class' * (case-insensitive, so ' Class' or ' CLASS' are also acceptable).
207213 - The class column is used for color-coding and shape assignment in various visualizations.
208214
2092154. Header Row:
210- - The first row of the CSV file should contain column names.
216+ - The first row of the CSV file should contain column (attribute) names.
211217
2122185. Delimiter:
213219 - Values should be separated by commas.
214220
215- Example CSV structure:
221+ # ## Example Dataset
222+
223+ dataset structure:
216224
217225| x1 | x2 | x3 | x4 | x5 | class |
218226| -------| -------| -------| -------| -------| -------|
@@ -222,13 +230,22 @@ Example CSV structure:
222230| 9.99 | 8.88 | 7.77 | 6.66 | 5.55 | C |
223231| 1.23 | 4.56 | 7.89 | 2.34 | 5.67 | B |
224232
233+ example.csv:
234+
235+ x1, x2, x3, x4, x5, class,
236+ 3.14, 2.71, 1.41, 0.58, 1.73, A,
237+ 2.22, 4.44, 3.33, 1.11, 5.55, B,
238+ 0.87, 1.23, 3.45, 5.67, 7.89, A,
239+ 9.99, 8.88, 7.77, 6.66, 5.55, C,
240+ 1.23, 4.56, 7.89, 2.34, 5.67, B
241+
225242# # Acknowledgements
226243
227244The user interface icons are sourced from [Font Awesome](https://fontawesome.com/search), converted using the [fa2png tool](https://fa2png.app/).
228245
229246The charts in the application are rendered using [JFreeChart](https://www.jfree.org/jfreechart/), a Java library for chart creation.
230247
231- # # License
248+ # # License Information
232249
233250JTabViz is licensed under the MIT License, allowing free use for both personal and commercial purposes. For full terms, see the ` LICENSE` file.
234251
0 commit comments