Skip to content
This repository was archived by the owner on Aug 17, 2024. It is now read-only.

Commit 403523b

Browse files
committed
Modifying the doc
1 parent 070b0a2 commit 403523b

File tree

9 files changed

+125
-124
lines changed

9 files changed

+125
-124
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ df.show()
2121
| undefined | 6 | undefined |
2222
````
2323

24-
dataframe-js provides some **immutable objects** (DataFrame, Row...) and an API closed to **functional** programming and **SQL syntax**.
24+
dataframe-js provides some **immutable objects** (DataFrame, Row...) and an API closed to **functional** programming and **SQL syntax**. You can sort, groupBy, join, and do complex manipulations with a simple sintax.
2525

2626
It is also compatible (import / export) with native JavaScript objects (Array, Hash...) and other formats (csv, json...).
2727

@@ -111,13 +111,13 @@ DataFrame.fromJSON('http://myurl/myfile.json').then(df => df)
111111

112112
[Export](./doc/index.md#export): Export a DataFrame in different files format or javascript objects.
113113

114-
[Working with all the DataFrame](./doc/index.md#general): Display and manipulate your DataFrame.
114+
[DataFrame informations](./doc/index.md#informations): Show some informations about your DataFrame.
115115

116-
[Working with Columns](./doc/index.md#columns): Use Columns to format your DataFrame.
116+
[Working with Columns](./doc/index.md#columns): Use Columns to format or to restructure your DataFrame.
117117

118-
[Working with Rows](./doc/index.md#rows): Manipulate and transform rows of a DataFrame.
118+
[Working with Rows](./doc/index.md#rows): Manipulate and transform rows of your DataFrame.
119119

120-
[Working at Row level](./doc/index.md#row): Use the Row api to set or get some values on each Row when you map, filter or simply manipulate Rows...
120+
[Working at Row level](./doc/index.md#row): Use the Row api to set or get some values when you map, filter or other Rows manipulations...
121121

122122
[Working with aggregates](./doc/index.md#groupeddataframe): Apply aggregations when you groupBy a DataFrame in order to resume your data.
123123

doc/html-api/index.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -693,7 +693,7 @@ <h3 class='fl m0' id='dataframe'>
693693
DataFrame
694694
</h3>
695695

696-
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/Gmousse/dataframe-js/blob/cf7ebcff6a537f0fb0c56b5e722d66c4b1c3903f/src/dataframe.js#L16-L843'>
696+
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/Gmousse/dataframe-js/blob/070b0a2b133ce27d8d80e2ab34b55c0198d87996/src/dataframe.js#L16-L843'>
697697
<span>src/dataframe.js</span>
698698
</a>
699699

@@ -4452,7 +4452,7 @@ <h3 class='fl m0' id='groupeddataframe'>
44524452
GroupedDataFrame
44534453
</h3>
44544454

4455-
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/Gmousse/dataframe-js/blob/cf7ebcff6a537f0fb0c56b5e722d66c4b1c3903f/src/groupedDataframe.js#L10-L118'>
4455+
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/Gmousse/dataframe-js/blob/070b0a2b133ce27d8d80e2ab34b55c0198d87996/src/groupedDataframe.js#L10-L118'>
44564456
<span>src/groupedDataframe.js</span>
44574457
</a>
44584458

@@ -4910,7 +4910,7 @@ <h3 class='fl m0' id='stat'>
49104910
Stat
49114911
</h3>
49124912

4913-
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/Gmousse/dataframe-js/blob/cf7ebcff6a537f0fb0c56b5e722d66c4b1c3903f/src/modules/stat.js#L6-L128'>
4913+
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/Gmousse/dataframe-js/blob/070b0a2b133ce27d8d80e2ab34b55c0198d87996/src/modules/stat.js#L6-L128'>
49144914
<span>src/modules/stat.js</span>
49154915
</a>
49164916

@@ -5619,7 +5619,7 @@ <h3 class='fl m0' id='matrix'>
56195619
Matrix
56205620
</h3>
56215621

5622-
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/Gmousse/dataframe-js/blob/cf7ebcff6a537f0fb0c56b5e722d66c4b1c3903f/src/modules/matrix.js#L9-L94'>
5622+
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/Gmousse/dataframe-js/blob/070b0a2b133ce27d8d80e2ab34b55c0198d87996/src/modules/matrix.js#L9-L94'>
56235623
<span>src/modules/matrix.js</span>
56245624
</a>
56255625

@@ -6029,7 +6029,7 @@ <h3 class='fl m0' id='sql'>
60296029
SQL
60306030
</h3>
60316031

6032-
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/Gmousse/dataframe-js/blob/cf7ebcff6a537f0fb0c56b5e722d66c4b1c3903f/src/modules/sql.js#L9-L102'>
6032+
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/Gmousse/dataframe-js/blob/070b0a2b133ce27d8d80e2ab34b55c0198d87996/src/modules/sql.js#L9-L102'>
60336033
<span>src/modules/sql.js</span>
60346034
</a>
60356035

@@ -6631,7 +6631,7 @@ <h3 class='fl m0' id='row'>
66316631
Row
66326632
</h3>
66336633

6634-
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/Gmousse/dataframe-js/blob/cf7ebcff6a537f0fb0c56b5e722d66c4b1c3903f/src/row.js#L12-L155'>
6634+
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/Gmousse/dataframe-js/blob/070b0a2b133ce27d8d80e2ab34b55c0198d87996/src/row.js#L12-L155'>
66356635
<span>src/row.js</span>
66366636
</a>
66376637

doc/index.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@
1818

1919
---
2020

21-
#### General
21+
#### Informations
2222

2323
[.show()](./md-api/dataframe.md#show),
2424
[.dim()](./md-api/dataframe.md#dim),
25-
[.transpose()](./md-api/dataframe.md#transpose)
25+
[.count()](./md-api/dataframe.md#count),
26+
[.listColumns()](./md-api/dataframe.md#listcolumns)
2627

2728
---
2829

2930
#### Columns
3031

31-
[.listColumns()](./md-api/dataframe.md#listcolumns),
3232
[.select()](./md-api/dataframe.md#select),
3333
[.withColumn()](./md-api/dataframe.md#withcolumn),
3434
[.countValue()](./md-api/dataframe.md#countvalue),
@@ -40,12 +40,12 @@
4040
[.cast()](./md-api/dataframe.md#cast),
4141
[.castAll()](./md-api/dataframe.md#castall),
4242
[.drop()](./md-api/dataframe.md#drop),
43+
[.transpose()](./md-api/dataframe.md#transpose)
4344

4445
---
4546

4647
#### Rows
4748

48-
[.count()](./md-api/dataframe.md#count),
4949
[.push()](./md-api/dataframe.md#push),
5050
[.replace()](./md-api/dataframe.md#replace),
5151
[.chain()](./md-api/dataframe.md#chain),
@@ -55,6 +55,7 @@
5555
[.find()](./md-api/dataframe.md#find),
5656
[.reduce()](./md-api/dataframe.md#reduce),
5757
[.reduceRight()](./md-api/dataframe.md#reducebight),
58+
[.dropDuplicates()](./md-api/dataframe.md#dropduplicates),
5859
[.shuffle()](./md-api/dataframe.md#shuffle),
5960
[.sample()](./md-api/dataframe.md#sample),
6061
[.groupBy()](./md-api/dataframe.md#groupby),

0 commit comments

Comments
 (0)