updated ReadMe

README.md

@@ -1,17 +1,16 @@
+<p align="center"><img width="300" height="300" src="https://github.com/hpi-swa-teaching/StatisticsWorkbench/blob/745c8d8d15afdd32273f4cc16a225b2b77bbdb9c/sw_logo.png?raw=true" alt="StatisticsWorkbench-Logo"></p>
 
-# Statistics Workbench
+<h1 align="center" style=font-size:100px>StatisticsWorkbench</h1>
 
-dev: 
-[![CI](https://github.com/hpi-swa-teaching/StatisticsWorkbench/actions/workflows/ci.yml/badge.svg?branch=dev)](https://github.com/hpi-swa-teaching/StatisticsWorkbench/actions/workflows/ci.yml)
-[![Build Status](https://api.travis-ci.org/hpi-swa-teaching/StatisticsWorkbench.svg?branch=dev)](https://travis-ci.org/hpi-swa-teaching/StatisticsWorkbench)
+[![Commit](https://img.shields.io/github/last-commit/hpi-swa-teaching/StatisticsWorkbench?style=flat)](https://github.com/hpi-swa-teaching/StatisticsWorkbenchStatisticsWorkbench/commits/)
 [![Coverage Status](https://coveralls.io/repos/github/hpi-swa-teaching/StatisticsWorkbench/badge.svg?branch=dev)](https://coveralls.io/github/hpi-swa-teaching/StatisticsWorkbench?branch=dev)
-
-(SWT21-Project-16)
+[![CI](https://github.com/hpi-swa-teaching/StatisticsWorkbench/actions/workflows/ci.yml/badge.svg?branch=dev)](https://github.com/hpi-swa-teaching/StatisticsWorkbench/actions/workflows/ci.yml)
 
 Statistics Workbench is a tool for the visualization and analyzation of data.
 It offers multiple mathematical functions for finding the maximum, minimum, mean, mode, maximal deviation and more of a dataset, as well as multiple chart types, like barcharts and piecharts.
 There are multiple ways of creating datasets from different inputs outlined below.
 
+
 ## Overview & Getting Started
 
 Statistics workbench offers a large number of functionalities for displaying the different charts, however it is not complete yet and not all functionalities are supported by all chart types yet.
@@ -155,15 +154,46 @@ You can also interact with the diagram, for example by right-clicking on data po
 - Normalized BarChart
 - Normalized AreaChart
 
-Here is an example of how to create a stacked chart for multiple y-axes:
+Here are two examples of how to create stacked and normalized charts for multiple y-axes:
+```smalltalk
+(SWDiagram new 
+    stacked: true;
+    visualizeAll: dataCollection with: SWBarChart) openInWindowLabeled: ''
+```
 ```smalltalk
-(SWDiagram new stacked: true;
+(SWDiagram new 
+    stacked: true;
+    normalized: true;
     visualizeAll: dataCollection with: SWBarChart) openInWindowLabeled: ''
 ```
 Here "dataCollection" is of type OrderedCollection with elemets from SWDataLabeled or SWDataUnlabeled.
 
+
+**Charts that suppot 3-dimensional data:**
+- BubblePlot
+
+Here is an examples of how to create a bubbleplot for 3-dimensional data:
+```smalltalk
+| data |
+data := SWDataUnlabeled fromXValues: {1 . 2 . 3 . 4 . 5} versusYValues: {5 . 200 . 38 . 69 . 16} versusZValues: {17 . 14 . 5 . 8 . 3}.
+(SWDiagram new visualize: data with: SWBubblePlot) openInWindowLabeled: ''
+```
+It is also possible to visualize more than one data series within a BubblePlot by using the method ```SWDiagram new visualizeAll: dataCollection with: SWBubblePlot```.
+
+
+## Linear Regression
+It is also possible to perform **Linear Regression** on a ScatterPlot.
+ ```smalltalk
+| data scatterPlot |
+data := SWDataUnlabeled fromXValues: {1 . 2 . 3 . 4 . 5} versusYValues: {22 . 110 . 64 . 211 . 35}.
+scatterPlot := SWDiagram new visualize: data with: SWScatterPlot.
+(SWLinearRegression newFromScatterPlot: (scatterPlot charts first) plotOn: scatterPlot).
+scatterPlot openInWindowLabeled: ''
+```
+
+
 ## The Statistic Workbench UI
-Another way of accesing the StatisticsWorkBench tool is the brand new user interface. This can be opened by calling
+Another way of accesing the StatisticsWorkBench tool is the brand new **User Interface**. This can be opened by calling
 
 ```smalltalk
 SWMainformModel open.
@@ -183,3 +213,13 @@ If you want to remove or edit y-axis values, simply select the desired rows and
 
 #### Important Note:
 If you only have one y-axis value in your UI field, you can visualize all charts. However, if you have multiple y-axis values, you can't visualize the pieChart and will get an error message because this chart type is not designed to have more y-axes. All other charts will be stacked as you would expect with additional y-axes.
+
+### Using the CSV import
+Note that csv file you want to import must have the following format:
+```
+X;Y1;Y2;Label
+1;1;2;one
+2;1;3;two
+3;3;4;three
+4;1;2;four
+```