Skip to content

Commit dae58a9

Browse files
authored
Merge pull request #243 from Joshua-Dias-Barreto/Readme
Fixed #224. Improved the Readme
2 parents 0be7b95 + cf1e02f commit dae58a9

6 files changed

Lines changed: 40 additions & 9 deletions

File tree

README.md

Lines changed: 40 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
[![Coverage Status](https://coveralls.io/repos/github/PolyMathOrg/DataFrame/badge.svg?branch=master)](https://coveralls.io/github/PolyMathOrg/DataFrame?branch=master)
44
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/PolyMathOrg/DataFrame/master/LICENSE)
55

6-
DataFrame is a tabular data structure for data analysis in [Pharo](https://pharo.org/).
6+
DataFrame is a tabular data structure for data analysis in [Pharo](https://pharo.org/). It organizes and represents data in a tabular format, resembling a spreadsheet or database table. It is designed to handle structured data and offer various functionalities for data manipulation and analysis. DataFrames are used as visualization tools for Machine Learning and Data Science related tasks.
77

8-
<img width="700" src="img/weatherDf.png">
8+
<img width="700" src="img/weatherDfDataInspector.png">
99

1010
## Installation
1111
To install the latest stable version of DataFrame (`pre-v3`), go to the Playground (`Ctrl+OW`) in your Pharo image and execute the following Metacello script (select it and press Do-it button or `Ctrl+D`):
@@ -58,37 +58,68 @@ weather := DataFrame withRows: #(
5858
(-2.3 false -)
5959
(3.2 true rain)).
6060
```
61+
| | 1 | 2 | 3 |
62+
|-------|------|-------|------|
63+
| **1** | 2.4 | true | rain |
64+
| **2** | 0.5 | true | rain |
65+
| **3** | -1.2 | true | snow |
66+
| **4** | -2.3 | false | - |
67+
| **5** | 3.2 | true | rain |
68+
6169

6270
### Removing the third row of the data frame
6371

6472
```Smalltalk
6573
weather removeRowAt: 3.
6674
```
67-
<img width="700" src="img/weatherDfRemoveRow.png">
75+
| | 1 | 2 | 3 |
76+
|-------|------|-------|------|
77+
| **1** | 2.4 | true | rain |
78+
| **2** | 0.5 | true | rain |
79+
| **4** | -2.3 | false | - |
80+
| **5** | 3.2 | true | rain |
6881

6982
### Adding a row to the data frame
7083

7184
```Smalltalk
72-
weather addRow: #(-1.2 true snow) named:''.
85+
weather addRow: #(-1.2 true snow) named: 6.
7386
```
74-
<img width="700" src="img/weatherDfAddRow.png">
87+
| | 1 | 2 | 3 |
88+
|-------|------|-------|------|
89+
| **1** | 2.4 | true | rain |
90+
| **2** | 0.5 | true | rain |
91+
| **4** | -2.3 | false | - |
92+
| **5** | 3.2 | true | rain |
93+
| **6** | -1.2 | true | snow |
7594

7695
### Replacing the data in the first row and third column with 'snow'
7796

7897
```Smalltalk
7998
weather at:1 at:3 put:#snow.
8099
```
81-
<img width="700" src="img/weatherDfReplaceData.png">
100+
| | 1 | 2 | 3 |
101+
|-------|------|-------|------|
102+
| **1** | 2.4 | true | snow |
103+
| **2** | 0.5 | true | rain |
104+
| **4** | -2.3 | false | - |
105+
| **5** | 3.2 | true | rain |
106+
| **6** | -1.2 | true | snow |
82107

83108
### Transpose of the data frame
84109

85110
```Smalltalk
86111
weather transposed.
87112
```
88-
<img width="700" src="img/weatherDfTranspose.png">
113+
| | 1 | 2 | 4 | 5 | 6 |
114+
|-------|------|------|-------|------|------|
115+
| **1** | 2.4 | 0.5 | -2.3 | 3.2 | -1.2 |
116+
| **2** | true | true | false | true | true |
117+
| **3** | snow | rain | - | rain | snow |
89118

90-
## DataFrame Booklet
119+
## Documentation and Literature
91120

92-
For more information, please read [Data Analysis Made Simple with Pharo DataFrame](https://github.com/SquareBracketAssociates/Booklet-DataFrame) - a booklet that serves as the main source of documentation for the DataFrame project. It describes the complete API of DataFrame and DataSeries data structures, and provides examples for each method.
121+
1. [Data Analysis Made Simple with Pharo DataFrame](https://github.com/SquareBracketAssociates/Booklet-DataFrame) - a booklet that serves as the main source of documentation for the DataFrame project. It describes the complete API of DataFrame and DataSeries data structures, and provides examples for each method.
93122

94123
[![DataFrame Booklet](img/booklet.png)](https://github.com/SquareBracketAssociates/Booklet-DataFrame)
124+
125+
2. Zaytsev Oleksandr, Nick Papoulias and Serge Stinckwich. [Towards Exploratory Data Analysis for Pharo](https://dl.acm.org/doi/10.1145/3139903.3139918) In Proceedings of the 12th edition of the International Workshop on Smalltalk Technologies, pp. 1-6. 2017.

img/weatherDfAddRow.png

-33.7 KB
Binary file not shown.

img/weatherDfDataInspector.png

53.7 KB
Loading

img/weatherDfRemoveRow.png

-29.5 KB
Binary file not shown.

img/weatherDfReplaceData.png

-35.5 KB
Binary file not shown.

img/weatherDfTranspose.png

-28.1 KB
Binary file not shown.

0 commit comments

Comments
 (0)