Skip to content

Commit 558b3f4

Browse files
risenWgitbook-bot
risenW
authored and
gitbook-bot
committed
GitBook: [#213] Update doc guide for new TS version
1 parent f31f4f0 commit 558b3f4

File tree

182 files changed

+4378
-3696
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

182 files changed

+4378
-3696
lines changed

‎README.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ description: >-
77

88
# Danfo.js Documentation
99

10-
D**anfo.js** is heavily inspired by the [Pandas](https://pandas.pydata.org/pandas-docs/stable/index.html) library and provides a similar interface and API. This means users familiar with the [Pandas ](https://pandas.pydata.org/pandas-docs/stable/index.html)API can easily use D**anfo.js.** 
10+
D**anfo.js** is heavily inspired by the [Pandas](https://pandas.pydata.org/pandas-docs/stable/index.html) library and provides a similar interface and API. This means users familiar with the [Pandas ](https://pandas.pydata.org/pandas-docs/stable/index.html)API can easily use D**anfo.js.**
1111

1212
## Main Features
1313

14-
* Danfo.js is fast and supports[ Tensorflow.js](https://js.tensorflow.org)'s tensors out of the box. This means you can [convert Danfo.js ](api-reference/dataframe/)DataFrames to Tensors, and vice versa. 
15-
* Easy handling of missing **** data (represented as `NaN`) in floating point as well as non-floating point data
14+
* Danfo.js is fast and supports[ Tensorflow.js](https://js.tensorflow.org)'s tensors out of the box. This means you can [convert Danfo.js ](api-reference/dataframe/)DataFrames to Tensors, and vice versa.
15+
* Easy handling of missing data (represented as `NaN, undefined, or null`) in data
1616
* Size mutability: columns can be inserted/deleted from DataFrame
1717
* Automatic and explicit alignment: objects can be explicitly aligned to a set of labels, or the user can simply ignore the labels and let [`Series`](api-reference/series/), [`DataFrame`](api-reference/dataframe/), etc. automatically align the data for you in computations
1818
* Powerful, flexible, [groupby](api-reference/groupby/) functionality to perform split-apply-combine operations on data sets, for both aggregating and transforming data
@@ -26,15 +26,15 @@ D**anfo.js** is heavily inspired by the [Pandas](https://pandas.pydata.org/panda
2626

2727
## Getting Started
2828

29-
New to Danfo? Check out the getting started guides. It contains a quick introduction to D_anfo's_ main concepts and links to additional content.
29+
New to Danfo? Check out the getting started guides. It contains a quick introduction to D\_anfo's\_ main concepts and links to additional content.
3030

3131
{% content-ref url="getting-started.md" %}
3232
[getting-started.md](getting-started.md)
3333
{% endcontent-ref %}
3434

3535
## **API Reference**
3636

37-
The reference guide contains a detailed description of the **danfo** API. The reference describes how each function works and which parameters can be used. 
37+
The reference guide contains a detailed description of the **danfo** API. The reference describes how each function works and which parameters can be used.
3838

3939
{% content-ref url="api-reference/" %}
4040
[api-reference](api-reference/)
@@ -54,7 +54,7 @@ The reference guide contains a detailed description of the **danfo** API. The re
5454

5555
## Contributing Guide
5656

57-
Want to help improve our documentation and existing functionalities? The contributing guidelines will guide you through the process. 
57+
Want to help improve our documentation and existing functionalities? The contributing guidelines will guide you through the process.
5858

5959
{% content-ref url="contributing-guide.md" %}
6060
[contributing-guide.md](contributing-guide.md)
@@ -65,4 +65,3 @@ Want to help improve our documentation and existing functionalities? The contrib
6565
{% content-ref url="release-notes.md" %}
6666
[release-notes.md](release-notes.md)
6767
{% endcontent-ref %}
68-

‎SUMMARY.md

+57-48
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,37 @@
44
* [Getting Started](getting-started.md)
55
* [API reference](api-reference/README.md)
66
* [General Functions](api-reference/general-functions/README.md)
7-
* [danfo.date\_range](api-reference/general-functions/danfo.date\_range.md)
7+
* [danfo.tensorflow](api-reference/general-functions/danfo.tensorflow.md)
8+
* [danfo. convertFunctionTotransformer](api-reference/general-functions/danfo.-convertfunctiontotransformer.md)
9+
* [danfo.streamCsvTransformer](api-reference/general-functions/danfo.streamcsvtransformer.md)
10+
* [danfo.streamJSON](api-reference/general-functions/danfo.streamjson.md)
11+
* [danfo.streamCSV](api-reference/general-functions/danfo.streamcsv.md)
12+
* [danfo.Utils](api-reference/general-functions/danfo.utils.md)
13+
* [danfo.Str](api-reference/general-functions/danfo.str.md)
14+
* [danfo.Dt](api-reference/general-functions/danfo.dt.md)
15+
* [danfo.dateRange](api-reference/general-functions/danfo.date\_range.md)
816
* [danfo.OneHotEncoder](api-reference/general-functions/danfo.onehotencoder.md)
917
* [danfo.StandardScaler](api-reference/general-functions/danfo.standardscaler.md)
1018
* [danfo.MinMaxScaler](api-reference/general-functions/danfo.minmaxscaler.md)
1119
* [danfo.LabelEncoder](api-reference/general-functions/danfo.labelencoder.md)
1220
* [danfo.toDateTime](api-reference/general-functions/danfo.to\_datetime.md)
13-
* [danfo.get\_dummies](api-reference/general-functions/danfo.get\_dummies.md)
21+
* [danfo.getDummies](api-reference/general-functions/danfo.get\_dummies.md)
1422
* [danfo.concat](api-reference/general-functions/danfo.concat.md)
1523
* [danfo.merge](api-reference/general-functions/danfo.merge.md)
1624
* [Input/Output](api-reference/input-output/README.md)
17-
* [danfo.read\_excel](api-reference/input-output/danfo.read\_excel.md)
18-
* [danfo.read\_json](api-reference/input-output/danfo.read\_json.md)
19-
* [danfo.read\_csv](api-reference/input-output/danfo.read\_csv.md)
20-
* [danfo.to\_csv](api-reference/input-output/danfo.to\_csv.md)
21-
* [danfo.to\_excel](api-reference/input-output/danfo.to\_excel.md)
22-
* [danfo.to\_json](api-reference/input-output/danfo.to\_json.md)
25+
* [danfo.readExcel](api-reference/input-output/danfo.read\_excel.md)
26+
* [danfo.toExcel](api-reference/input-output/danfo.to\_excel.md)
27+
* [danfo.readJSON](api-reference/input-output/danfo.read\_json.md)
28+
* [danfo.toJSON](api-reference/input-output/danfo.to\_json.md)
29+
* [danfo.readCSV](api-reference/input-output/danfo.read\_csv.md)
30+
* [danfo.toCSV](api-reference/input-output/danfo.to\_csv.md)
2331
* [Series](api-reference/series/README.md)
2432
* [Creating a Series](api-reference/series/creating-a-series.md)
2533
* [Series.append](api-reference/series/series.append.md)
26-
* [Series.cumsum](api-reference/series/series.cumsum.md)
27-
* [Series.cummax](api-reference/series/series.cummax.md)
28-
* [Series.cumprod](api-reference/series/series.cumprod.md)
29-
* [Series.cummin](api-reference/series/series.cummin.md)
34+
* [Series.cumSum](api-reference/series/series.cumsum.md)
35+
* [Series.cumMax](api-reference/series/series.cummax.md)
36+
* [Series.cumProd](api-reference/series/series.cumprod.md)
37+
* [Series.cumMin](api-reference/series/series.cummin.md)
3038
* [Series.str.split](api-reference/series/series.str.split.md)
3139
* [Series.str.len](api-reference/series/series.str.len.md)
3240
* [Series.str.join](api-reference/series/series.str.join.md)
@@ -49,23 +57,23 @@
4957
* [Series.str.capitalize](api-reference/series/series.str.capitalize.md)
5058
* [Series.dt.seconds](api-reference/series/series.dt.second.md)
5159
* [Series.dt.minutes](api-reference/series/series.dt.minute.md)
52-
* [Series.dt.monthday](api-reference/series/series.dt.monthday.md)
53-
* [Series.dt.month\_name](api-reference/series/series.dt.month\_name.md)
54-
* [Series.dt.hour](api-reference/series/series.dt.hour.md)
55-
* [Series.dt.weekdays](api-reference/series/series.dt.weekdays.md)
56-
* [Series.dt.day](api-reference/series/series.dt.day.md)
60+
* [Series.dt.dayOfMonth](api-reference/series/series.dt.monthday.md)
61+
* [Series.dt.monthName](api-reference/series/series.dt.month\_name.md)
62+
* [Series.dt.hours](api-reference/series/series.dt.hour.md)
63+
* [Series.dt.dayOfWeek](api-reference/series/series.dt.weekdays.md)
64+
* [Series.dt.dayOfWeek](api-reference/series/series.dt.day.md)
5765
* [Series.dt.month](api-reference/series/series.dt.month.md)
5866
* [Series.dt.year](api-reference/series/series.dt.year.md)
59-
* [Series.argmax](api-reference/series/series.argmax.md)
60-
* [Series.argmin](api-reference/series/series.argmin.md)
61-
* [Series.argsort](api-reference/series/series.argsort.md)
67+
* [Series.argMax](api-reference/series/series.argmax.md)
68+
* [Series.argMin](api-reference/series/series.argmin.md)
69+
* [Series.argSort](api-reference/series/series.argsort.md)
6270
* [Series.replace](api-reference/series/series.replace.md)
63-
* [Series.isna](api-reference/series/series.isna.md)
64-
* [Series.fillna](api-reference/series/series.fillna.md)
65-
* [Series.dropna](api-reference/series/series.dropna.md)
66-
* [Series.drop\_duplicates](api-reference/series/series.drop\_duplicates.md)
67-
* [Series.value\_counts](api-reference/series/series.value\_counts.md)
68-
* [Series.nunique](api-reference/series/series.nunique.md)
71+
* [Series.isNa](api-reference/series/series.isna.md)
72+
* [Series.fillNa](api-reference/series/series.fillna.md)
73+
* [Series.dropNa](api-reference/series/series.dropna.md)
74+
* [Series.dropDuplicates](api-reference/series/series.drop\_duplicates.md)
75+
* [Series.valueCounts](api-reference/series/series.value\_counts.md)
76+
* [Series.nUnique](api-reference/series/series.nunique.md)
6977
* [Series.unique](api-reference/series/series.unique.md)
7078
* [Series.abs](api-reference/series/series.abs.md)
7179
* [Series.ne](api-reference/series/series.ne.md)
@@ -84,11 +92,11 @@
8492
* [Series.index](api-reference/series/series.index.md)
8593
* [Series.apply](api-reference/series/series.apply.md)
8694
* [Series.map](api-reference/series/series.map.md)
87-
* [Series.set\_index](api-reference/series/series.set\_index.md)
88-
* [Series.reset\_index](api-reference/series/series.reset\_index.md)
95+
* [Series.setIndex](api-reference/series/series.set\_index.md)
96+
* [Series.resetIndex](api-reference/series/series.reset\_index.md)
8997
* [Series.describe](api-reference/series/series.describe.md)
9098
* [Series.copy](api-reference/series/series.copy.md)
91-
* [Series.sort\_values](api-reference/series/series.sort\_values.md)
99+
* [Series.sortValues](api-reference/series/series.sort\_values.md)
92100
* [Series.var](api-reference/series/series.var.md)
93101
* [Series.std](api-reference/series/series.std.md)
94102
* [Series.round](api-reference/series/series.round.md)
@@ -114,25 +122,25 @@
114122
* [Series.or](api-reference/series/series.or.md)
115123
* [Dataframe](api-reference/dataframe/README.md)
116124
* [Creating a DataFrame](api-reference/dataframe/creating-a-dataframe.md)
117-
* [DataFrame.sort\_index](api-reference/dataframe/dataframe.sort\_index.md)
125+
* [DataFrame.sortIndex](api-reference/dataframe/dataframe.sort\_index.md)
118126
* [DataFrame.append](api-reference/dataframe/dataframe.append.md)
119-
* [DataFrame.nunique](api-reference/dataframe/dataframe.nunique-1.md)
127+
* [DataFrame.nUnique](api-reference/dataframe/dataframe.nunique-1.md)
120128
* [DataFrame.tensor](api-reference/dataframe/dataframe.tensor.md)
121129
* [DataFrame.print](api-reference/dataframe/dataframe.print.md)
122-
* [DataFrame.to\_csv](api-reference/dataframe/dataframe.to\_csv.md)
123-
* [DataFrame.to\_json](api-reference/dataframe/dataframe.to\_json.md)
124-
* [DataFrame.to\_excel](api-reference/dataframe/dataframe.to\_excel.md)
125-
* [DataFrame.sort\_values](api-reference/dataframe/dataframe.sort\_values.md)
126-
* [DataFrame.set\_index](api-reference/dataframe/dataframe.set\_index.md)
127-
* [DataFrame.reset\_index](api-reference/dataframe/dataframe.reset\_index.md)
130+
* [DataFrame.toCSV](api-reference/dataframe/dataframe.to\_csv.md)
131+
* [DataFrame.toJSON](api-reference/dataframe/dataframe.to\_json.md)
132+
* [DataFrame.toExcel](api-reference/dataframe/dataframe.to\_excel.md)
133+
* [DataFrame.sortValues](api-reference/dataframe/dataframe.sort\_values.md)
134+
* [DataFrame.setIndex](api-reference/dataframe/dataframe.set\_index.md)
135+
* [DataFrame.resetIndex](api-reference/dataframe/dataframe.reset\_index.md)
128136
* [DataFrame.rename](api-reference/dataframe/dataframe.rename.md)
129137
* [DataFrame.drop](api-reference/dataframe/dataframe.drop.md)
130-
* [DataFrame.astype](api-reference/dataframe/dataframe.astype.md)
138+
* [DataFrame.asType](api-reference/dataframe/dataframe.astype.md)
131139
* [DataFrame.shape](api-reference/dataframe/dataframe.shape.md)
132140
* [DataFrame.axis](api-reference/dataframe/dataframe.axes.md)
133141
* [DataFrame.ndim](api-reference/dataframe/dataframe.ndim.md)
134142
* [DataFrame.values](api-reference/dataframe/dataframe.values.md)
135-
* [DataFrame.select\_dtypes](api-reference/dataframe/dataframe.select\_dtypes.md)
143+
* [DataFrame.selectDtypes](api-reference/dataframe/dataframe.select\_dtypes.md)
136144
* [DataFrame.ctypes](api-reference/dataframe/dataframe.dtypes.md)
137145
* [DataFrame.index](api-reference/dataframe/dataframe.index.md)
138146
* [DataFrame.loc](api-reference/dataframe/danfo.dataframe.loc.md)
@@ -154,10 +162,10 @@
154162
* [DataFrame.var](api-reference/dataframe/danfo.dataframe.var.md)
155163
* [DataFrame.count](api-reference/dataframe/danfo.dataframe.count.md)
156164
* [DataFrame.round](api-reference/dataframe/danfo.dataframe.round.md)
157-
* [DataFrame.cumsum](api-reference/dataframe/danfo.dataframe.cumsum.md)
158-
* [DataFrame.cummin](api-reference/dataframe/danfo.dataframe.cummin.md)
159-
* [DataFrame.cummax](api-reference/dataframe/danfo.dataframe.cummax.md)
160-
* [DataFrame.cumprod](api-reference/dataframe/danfo.dataframe.cumprod.md)
165+
* [DataFrame.cumSum](api-reference/dataframe/danfo.dataframe.cumsum.md)
166+
* [DataFrame.cumMin](api-reference/dataframe/danfo.dataframe.cummin.md)
167+
* [DataFrame.cumMax](api-reference/dataframe/danfo.dataframe.cummax.md)
168+
* [DataFrame.cumProd](api-reference/dataframe/danfo.dataframe.cumprod.md)
161169
* [DataFrame.copy](api-reference/dataframe/danfo.dataframe.copy.md)
162170
* [DataFrame.describe](api-reference/dataframe/danfo.dataframe.describe.md)
163171
* [DataFrame.sum](api-reference/dataframe/danfo.dataframe.sum.md)
@@ -166,11 +174,11 @@
166174
* [DataFrame.addColumn](api-reference/dataframe/danfo.dataframe.addcolumn.md)
167175
* [DataFrame.groupby](api-reference/dataframe/danfo.dataframe.groupby.md)
168176
* [DataFrame.column](api-reference/dataframe/danfo.dataframe.column.md)
169-
* [DataFrame.fillna](api-reference/dataframe/danfo.dataframe.fillna.md)
170-
* [DataFrame.isna](api-reference/dataframe/danfo.dataframe.isna.md)
171-
* [DataFrame.dropna](api-reference/dataframe/danfo.dataframe.dropna.md)
177+
* [DataFrame.fillNa](api-reference/dataframe/danfo.dataframe.fillna.md)
178+
* [DataFrame.isNa](api-reference/dataframe/danfo.dataframe.isna.md)
179+
* [DataFrame.dropNa](api-reference/dataframe/danfo.dataframe.dropna.md)
172180
* [DataFrame.apply](api-reference/dataframe/danfo.dataframe.apply.md)
173-
* [DataFrame.apply\_map](api-reference/dataframe/dataframe.apply\_map.md)
181+
* [DataFrame.applyMap](api-reference/dataframe/dataframe.apply\_map.md)
174182
* [DataFrame.It](api-reference/dataframe/danfo.dataframe.it.md)
175183
* [DataFrame.gt](api-reference/dataframe/danfo.dataframe.gt.md)
176184
* [DataFrame.le](api-reference/dataframe/danfo.dataframe.le.md)
@@ -189,7 +197,7 @@
189197
* [Scatter Plots](api-reference/plotting/scatter-plots.md)
190198
* [Bar Charts](api-reference/plotting/bar-charts.md)
191199
* [Line Charts](api-reference/plotting/line-charts.md)
192-
* [Configuring your plots](api-reference/plotting/configuring-your-plots.md)
200+
* [Customizing your plots](api-reference/plotting/configuring-your-plots.md)
193201
* [Groupby](api-reference/groupby/README.md)
194202
* [Groupby.get\_groups](api-reference/groupby/groupby.get\_groups.md)
195203
* [Groupby.col](api-reference/groupby/groupby.col.md)
@@ -206,6 +214,7 @@
206214
* [Groupby.cumprod](api-reference/groupby/groupby.cumprod.md)
207215
* [Groupby.agg](api-reference/groupby/groupby.agg.md)
208216
* [User Guides](examples/README.md)
217+
* [Migrating to the stable version of Danfo.js](examples/migrating-to-the-stable-version-of-danfo.js.md)
209218
* [Using Danfojs in React](examples/using-danfojs-in-react.md)
210219
* [Titanic Survival Prediction using Danfo.js and Tensorflow.js](examples/titanic-survival-prediction-using-danfo.js-and-tensorflow.js.md)
211220
* [Building Data Driven Applications with Danfo.js - Book](building-data-driven-applications-with-danfo.js-book.md)

‎api-reference/README.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
---
22
description: >-
3-
This page gives an overview of all public danfo objects, functions and
4-
methods. All classes and functions exposed in danfo.* namespace are public.
3+
List of all public Danfo objects, functions and methods. All classes and
4+
functions exposed in danfo.* namespace is public.
55
---
66

77
# API reference
88

9+
{% hint style="info" %}
10+
A stable version of Danfojs (v1), has been released, and it comes with full Typescript support, new features, and many bug fixes. See release note [here](../release-notes.md#latest-release-node-v1.0.0-browser-v1.0.0). 
11+
12+
There are a couple of breaking changes, so we have prepared a short migration [guide](../examples/migrating-to-the-stable-version-of-danfo.js.md) for pre-v1 users. 
13+
{% endhint %}
14+
915
* [General Functions](general-functions/)
1016
* [Data manipulations](general-functions/#data-manipulations)
1117
* [Data Processing/Normalization](general-functions/#data-processing-normalization)
@@ -26,7 +32,7 @@ description: >-
2632
* [Accessors](series/#accessors)
2733
* [Serialization / IO / conversion](series/#serialization-io-conversion)
2834
* [DataFrame](dataframe/)
29-
* [Attributes ](dataframe/#attributes)
35+
* [Attributes](dataframe/#attributes)
3036
* [Conversion](dataframe/#conversion)
3137
* [Indexing, iteration](dataframe/#indexing-iteration)
3238
* [Binary operator functions](dataframe/#binary-operator-functions)
@@ -51,4 +57,3 @@ description: >-
5157
* [Indexing, iteration](groupby/#indexing-iteration)
5258
* [Function application](groupby/#function-application)
5359
* [Computations / descriptive stats](groupby/#computations-descriptive-stats)
54-

0 commit comments

Comments
 (0)