Boolean, whether to use minimal memory or not. Defaults to false.
Note: There's a slight decrease in speed when low memory mode is set to true.
| Parameters | -Type | -Description | -
|---|---|---|
| data | -2D Array, 2D Tensor, JSON object. | -Flat data structure to load into DataFrame | -
| options | -Object | -
- Optional configuration object. Supported properties are:
- index: Array of numeric or string names for subseting array. If
- not specified, indexes are auto-generated.
- columns: Array of column names. If not specified, column names are
- auto generated.
- dtypes: Array of data types for each the column. If not specified,
- dtypes are/is inferred.
- config: General configuration object for extending or setting NDframe - behavior. See full options here - |
-
{
axis: 0 for row, 1 for column.
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
}
| { axis: 1, inplace: false } | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -### Addition of **scalar to** DataFrame along default axis 1 - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24] -} -let df = new dfd.DataFrame(data) - -let df_new = df.add(2) - -df_new.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ 12 │ 25 ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ 47 │ 22 ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ 58 │ 12 ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ 12 │ 26 ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Addition of **Series to** DataFrame along axis 0 - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [1, 4, 5, 1], - "Col2": [3, 2, 0, 4] -} - -let df = new dfd.DataFrame(data) -let sf = new dfd.Series([4, 5]) - -let df_new = df.add(sf, { axis: 1 }) - -df_new.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ 5 │ 8 ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ 8 │ 7 ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ 9 │ 5 ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ 5 │ 9 ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Addition of **** DataFrame to a DataFrame - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs") - -let data = {"Col1": [1, 4, 5, 0], - "Col2": [2, 0, 1, 4]} - -let data2 = {"new_col1": [1, 5, 20, 10], - "new_Col2": [20, 2, 1, 2]} - -let df = new dfd.DataFrame(data) -let df2 = new dfd.DataFrame(data2) - -let df_new = df.add(df2) - -df_new.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ 2 │ 22 ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ 9 │ 2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ 25 │ 2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ 10 │ 6 ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Addition of **** Array to DataFrame along axis 0 - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24] -} - -let df = new dfd.DataFrame(data) -let val = [2, 2, 2, 2] - -let df_new = df.add(val, { axis: 0 }) - -df_new.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 12 │ 25 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 47 │ 22 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 58 │ 12 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 12 │ 26 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - -``` -{% endtab %} -{% endtabs %} - -### Addition works inplace - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24] -} - -let df = new dfd.DataFrame(data) -let val = [2, 2, 2, 2] - -df.add(val, { axis: 0, inplace: true }) - -df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 12 │ 25 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 47 │ 22 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 58 │ 12 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 12 │ 26 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.addcolumn.md b/api-reference-v1-stable/dataframe/danfo.dataframe.addcolumn.md deleted file mode 100644 index ef0ecc9..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.addcolumn.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -description: Add new column to a DataFrame ---- - -# DataFrame.addColumn - -danfo.DataFrame.**addColumn**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L1083)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | -| options | Object |{column : str, name of the column to add
values: Series, Array of new values to add
inplace: Default to false.
}
| | - -**Returns:** - -## **Examples** - -## **Add Array as a new column to DataFrame** - -New columns get added at the end of the DataFrame, and this happens so returns nothing, - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") -let data = {"A": [30, 1, 2, 3], - "B": [34, 4, 5, 6], - "C": [20, 20, 30, 40]} - -let df = new dfd.DataFrame(data) -df.print() - -let new_col = [1, 2, 3, 4] -df.addColumn({ "column": "D", "values": new_col, inplace: true }); - -df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 30 │ 34 │ 20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 4 │ 20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 2 │ 5 │ 30 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 3 │ 6 │ 40 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - Shape: (4,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C │ D ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 30 │ 34 │ 20 │ 1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 4 │ 20 │ 2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 2 │ 5 │ 30 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 3 │ 6 │ 40 │ 4 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -## **Add Series as a new column to DataFrame** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") -let data = {"A": [30, 1, 2, 3], - "B": [34, 4, 5, 6], - "C": [20, 20, 30, 40]} - -let df = new dfd.DataFrame(data) -let s = new dfd.Series([1, 2, 3, 4]) -df.addColumn({ "column": "D", "values": s, inplace: true }); - -df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C │ D ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 30 │ 34 │ 20 │ 1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 4 │ 20 │ 2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 2 │ 5 │ 30 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 3 │ 6 │ 40 │ 4 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.apply.md b/api-reference-v1-stable/dataframe/danfo.dataframe.apply.md deleted file mode 100644 index de42294..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.apply.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -description: Apply a function to each element or along a specified axis of a DataFrame. ---- - -# DataFrame.apply - -danfo.DataFrame.**apply**(callable, options) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L1566)] - -| Parameters | Type | Description | Default | -| ---------- | -------- | --------------------------------------------------------------------- | --------- | -| callable | Function | Function to apply to each column or row | | -| options | Object | **axis**: 0 or 1. If 0, compute the power column-wise, if 1, row-wise | {axis: 1} | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -### Apply a function along default axis 1 (columns) - -{% hint style="info" %} -Note that the specified function passed to `apply` will be called with an array of the values across the specified axis. -{% endhint %} - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = [[1, 2, 3], [4, 5, 6], [20, 30, 40], [39, 89, 78]] -let cols = ["A", "B", "C"] -let df = new dfd.DataFrame(data, { columns: cols }) - -function sum_vals(col) { - return col.reduce((a, b) => a + b, 0); -} - -let df_new = df.apply(sum_vals, { axis: 1 }) -df_new.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═════╗ -║ A │ 64 ║ -╟───┼─────╢ -║ B │ 126 ║ -╟───┼─────╢ -║ C │ 127 ║ -╚═══╧═════╝ -``` -{% endtab %} -{% endtabs %} - -### Apply a function along axis 0 (row) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = [[1, 2, 3], [4, 5, 6], [20, 30, 40], [39, 89, 78]] -let cols = ["A", "B", "C"] -let df = new dfd.DataFrame(data, { columns: cols }) - -function sum_vals(col) { - return col.reduce((a, b) => a + b, 0); -} - -let df_new = df.apply(sum_vals, { axis: 0 }) -df_new.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═════╗ -║ 0 │ 6 ║ -╟───┼─────╢ -║ 1 │ 15 ║ -╟───┼─────╢ -║ 2 │ 90 ║ -╟───┼─────╢ -║ 3 │ 206 ║ -╚═══╧═════╝ - -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.column.md b/api-reference-v1-stable/dataframe/danfo.dataframe.column.md deleted file mode 100644 index 7d963a2..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.column.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -description: Return the elements of the specified column in the DataFrame ---- - -# DataFrame.column - -danfo.DataFrame.**column**(column) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L1217)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ------------------------------------- | ------- | -| column | String | The name of a column in the DataFrame | | - -**Returns:** - - **** return **Series** - -## **Examples** - -## **Select a single column from a DataFrame** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") -let data = { "Name": ["Apples", "App", "Banana", undefined], - "Count": [NaN, 5, NaN, 10] , - "Price": [200, 300, 40, 250] } - -let df = new dfd.DataFrame(data) - -df.column("Name").print() - -//Alternatively, you can retrieve columns by using the object property -df['Name'].print() //produces the same result as above - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════╗ -║ 0 │ Apples ║ -╟───┼───────────╢ -║ 1 │ App ║ -╟───┼───────────╢ -║ 2 │ Banana ║ -╟───┼───────────╢ -║ 3 │ undefined ║ -╚═══╧═══════════╝ - -╔═══╤═══════════╗ -║ 0 │ Apples ║ -╟───┼───────────╢ -║ 1 │ App ║ -╟───┼───────────╢ -║ 2 │ Banana ║ -╟───┼───────────╢ -║ 3 │ undefined ║ -╚═══╧═══════════╝ - -``` -{% endtab %} -{% endtabs %} - -To select more than one column with specific rows, you can use any of the following: [DataFrame.loc](danfo.dataframe.loc.md), [DataFrame.iloc](danfo.dataframe.iloc.md) or [DataFrame.query](danfo.dataframe.query.md) diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.copy.md b/api-reference-v1-stable/dataframe/danfo.dataframe.copy.md deleted file mode 100644 index 188179d..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.copy.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -description: Makes a new copy of the DataFrame ---- - -# DataFrame.copy - -danfo.DataFrame.**copy**() \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L940)] - -**Returns:** - - **** return **new DataFrame** - -## **Examples** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") -let data = {"A": [-20.1, 30, 47.3, -20], - "B": [34, -4, 5, 6], - "C": [20, -20, 30, -40]} -let df = new dfd.DataFrame(data) -let new_df = df.copy() -new_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ -20.1 │ 34 │ 20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 30 │ -4 │ -20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 47.3 │ 5 │ 30 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ -20 │ 6 │ -40 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.count.md b/api-reference-v1-stable/dataframe/danfo.dataframe.count.md deleted file mode 100644 index 637cbf4..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.count.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -description: >- - Count non-NaN cells for each column or row. The values NaN and undefined are - considered NaN ---- - -# DataFrame.count - -danfo.DataFrame.**count**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L454)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ----------------------------------------------------------------------------------- | ----------- | -| options | Object | **axis:** 0 or 1. If 0, compute the mean column-wise, if 1, row-wise. Defaults to 1 | { axis: 1 } | - -**Returns:** - - **** return **Series** - -## **Examples** - -## Count Non-NaN values along default axis 1 (column) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "Name": ["Apples", "Mango", "Banana", undefined], - "Count": [NaN, 5, NaN, 10], - "Price": [200, 300, 40, 250] } - -let df = new dfd.DataFrame(data) -df.count().print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══════╤══════════════════════╗ -║ │ 0 ║ -╟───────┼──────────────────────╢ -║ Name │ 3 ║ -╟───────┼──────────────────────╢ -║ Count │ 2 ║ -╟───────┼──────────────────────╢ -║ Price │ 4 ║ -╚═══════╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -## Count Non-NaN values along row axis (0) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "Name": ["Apples", "Mango", "Banana", undefined], - "Count": [NaN, 5, NaN, 10], - "Price": [200, 300, 40, 250] } - -let df = new dfd.DataFrame(data) -df.count({axis: 0}).print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 2 ║ -╟───┼──────────────────────╢ -║ 1 │ 3 ║ -╟───┼──────────────────────╢ -║ 2 │ 2 ║ -╟───┼──────────────────────╢ -║ 3 │ 2 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -## - diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.cummax.md b/api-reference-v1-stable/dataframe/danfo.dataframe.cummax.md deleted file mode 100644 index fb69bb5..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.cummax.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -description: Return cumulative maximum over a DataFrame or Series axis. ---- - -# DataFrame.cummax - -danfo.DataFrame.**cummax**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L706)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | -| options | Object |axis: 0 for row and 1 for column
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
| {axis: 1, inplace: false} | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -## Cumulative maximum of elements along default axis (row) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -data = [[11, 20, 3], [1, 15, 6], [2, 30, 40], [2, 89, 78]] -cols = ["A", "B", "C"] - -let df = new dfd.DataFrame(data, { columns: cols }) -let new_df = df.cummax({ axis: 0 }) - -new_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 11 │ 20 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 11 │ 20 │ 6 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 11 │ 30 │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 11 │ 89 │ 78 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -## Cumulative maximum of elements along column axis (1) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -data = [[11, 20, 3], [1, 15, 6], [2, 30, 40], [2, 89, 78]] -cols = ["A", "B", "C"] - -let df = new dfd.DataFrame(data, { columns: cols }) -let new_df = df.cummax({ axis: 1 }) - -new_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 11 │ 20 │ 20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 15 │ 15 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 2 │ 30 │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 2 │ 89 │ 89 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.cummin.md b/api-reference-v1-stable/dataframe/danfo.dataframe.cummin.md deleted file mode 100644 index be026a6..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.cummin.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -description: Return cumulative minimum over a DataFrame or Series axis. ---- - -# DataFrame.cummin - -danfo.DataFrame.**cummin**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L706)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | -| options | Object |axis: 0 for row and 1 for column
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
| {axis: 1, inplace: false} | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -## Cumulative minimum of elements along default axis (row) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -data = [[11, 20, 3], [1, 15, 6], [2, 30, 40], [2, 89, 78]] -cols = ["A", "B", "C"] - -let df = new dfd.DataFrame(data, { columns: cols }) -let new_df = df.cummin({ axis: 0 }) - -new_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 11 │ 20 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 15 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 1 │ 15 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 1 │ 15 │ 3 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -## Cumulative minimum of elements along column axis (1) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -data = [[11, 20, 3], [1, 15, 6], [2, 30, 40], [2, 89, 78]] -cols = ["A", "B", "C"] - -let df = new dfd.DataFrame(data, { columns: cols }) -let new_df = df.cummin({ axis: 1 }) - -new_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 11 │ 11 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 1 │ 1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 2 │ 2 │ 2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 2 │ 2 │ 2 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.cumprod.md b/api-reference-v1-stable/dataframe/danfo.dataframe.cumprod.md deleted file mode 100644 index 06ad53a..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.cumprod.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -description: Return cumulative product over a DataFrame or Series axis. ---- - -# DataFrame.cumprod - -danfo.DataFrame.**cumprod**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L706)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | -| options | Object |axis: 0 for row and 1 for column
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
| {axis: 1, inplace: false} | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -## Cumulative product of elements along default axis (row) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -data = [[1, 2, 3], [1, 5, 6], [2, 30, 40], [2, 89, 78]] -cols = ["A", "B", "C"] - -let df = new dfd.DataFrame(data, { columns: cols }) -let new_df = df.cumprod() - -new_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 1 │ 2 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 10 │ 18 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 2 │ 300 │ 720 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 4 │ 26700 │ 56160 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -## Cumulative product of elements along column axis (1) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -data = [[1, 2, 3], [1, 5, 6], [2, 30, 40], [2, 89, 78]] -cols = ["A", "B", "C"] - -let df = new dfd.DataFrame(data, { columns: cols }) -let new_df = df.cumprod({axis: 1}) - -new_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 1 │ 2 │ 6 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 5 │ 30 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 2 │ 60 │ 2400 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 2 │ 178 │ 13884 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.cumsum.md b/api-reference-v1-stable/dataframe/danfo.dataframe.cumsum.md deleted file mode 100644 index 07be896..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.cumsum.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -description: Return cumulative sum over a DataFrame or Series axis. ---- - -# DataFrame.cumsum - -danfo.DataFrame.**cumsum**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L706)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | -| options | Object |axis: 0 for row and 1 for column
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
| {axis: 1, inplace: false} | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -## Cumulative sum of elements along default axis (row) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -data = [[11, 20, 3], [1, 15, 6], [2, 30, 40], [2, 89, 78]] -cols = ["A", "B", "C"] - -let df = new dfd.DataFrame(data, { columns: cols }) -let new_df = df.cumsum({ axis: 0 }) - -new_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 11 │ 20 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 12 │ 35 │ 9 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 14 │ 65 │ 49 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 16 │ 154 │ 127 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -## Cumulative sum of elements along column axis (1) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -data = [[11, 20, 3], [1, 15, 6], [2, 30, 40], [2, 89, 78]] -cols = ["A", "B", "C"] - -let df = new dfd.DataFrame(data, { columns: cols }) -let new_df = df.cumsum({ axis: 1 }) - -new_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 11 │ 31 │ 34 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 16 │ 22 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 2 │ 32 │ 72 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 2 │ 91 │ 169 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.describe.md b/api-reference-v1-stable/dataframe/danfo.dataframe.describe.md deleted file mode 100644 index 0540873..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.describe.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -description: >- - Generate descriptive statistics for each numeric column. Numeric columns are - of type Int and float. ---- - -# DataFrame.describe - -danfo.DataFrame.**describe**() \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L821)] - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -Descriptive statistics include those that summarize the central tendency, dispersion and shape of a dataset’s distribution, excluding `NaN` values. - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") -let data = [[0, 2, 4, "a"], [360, 180, 360, "b"], [2, 4, 6, "c"]] -let col_names = ["col1", "col2", "col3", "col4"] -let df = new dfd.DataFrame(data, {columns: col_names}) - -df.describe().print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ col1 │ col2 │ col3 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ count │ 3 │ 3 │ 3 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ mean │ 120.66666666666… │ 62 │ 123.33333333333… ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ std │ 207.27115895206… │ 102.19589032832… │ 204.961785055979 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ min │ 0 │ 2 │ 4 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ median │ 2 │ 4 │ 6 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ max │ 360 │ 180 │ 360 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ variance │ 42961.333333333… │ 10444 │ 42009.333333333… ║ -╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -## diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.div.md b/api-reference-v1-stable/dataframe/danfo.dataframe.div.md deleted file mode 100644 index c98c66e..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.div.md +++ /dev/null @@ -1,254 +0,0 @@ ---- -description: >- - Get Float division of DataFrame and other, element-wise (binary operator - truediv). ---- - -# DataFrame.div - -danfo.DataFrame.div(other, option) \[[source](https://github.com/opensource9ja/danfojs/blob/fe56860b0a303d218d60ba71dee6abf594401556/danfojs/src/core/frame.js#L347)] - -| Parameters | Type | Description | Default | -| ---------- | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| other | DataFrame, Series, Array or Scalar | Object to add with | | -| option | Object |{
axis: 0 for row, 1 for column.
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
}
| { axis: 1, inplace: false } | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -### Division of **scalar with** DataFrame along default axis 1 - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24] -} -let df = new dfd.DataFrame(data) - -let df_new = df.div(2) - -df_new.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 5 │ 11.5 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 22.5 │ 10 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 28 │ 5 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 5 │ 12 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - -``` -{% endtab %} -{% endtabs %} - -### Division of **Series with** DataFrame along axis 0 - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [1, 4, 5, 1], - "Col2": [3, 2, 0, 4] -} - -let df = new dfd.DataFrame(data) -let sf = new dfd.Series([4, 5]) - -let df_new = df.div(sf, { axis: 1 }) - -df_new.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 0.25 │ 0.6000000238418… ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 0.4000000059604… ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 1.25 │ 0 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 0.25 │ 0.8000000119209… ║ -╚════════════╧═══════════════════╧═══════════════════╝ - - -``` -{% endtab %} -{% endtabs %} - -### Division of **** DataFrame **with** a DataFrame - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs") - -let data = {"Col1": [1, 4, 5, 0], - "Col2": [2, 0, 1, 4]} - -let data2 = {"new_col1": [1, 5, 20, 10], - "new_Col2": [20, 2, 1, 2]} - -let df = new dfd.DataFrame(data) -let df2 = new dfd.DataFrame(data2) - -let df_new = df.div(df2) - -df_new.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 1 │ 0.1000000014901… ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 0.8000000119209… │ 0 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 0.25 │ 1 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 0 │ 2 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - - -``` -{% endtab %} -{% endtabs %} - -### Division of **** Array **with** DataFrame along axis 0 - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24] -} - -let df = new dfd.DataFrame(data) -let val = [2, 2, 2, 2] - -let df_new = df.div(val, { axis: 0 }) - -df_new.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 5 │ 11.5 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 22.5 │ 10 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 28 │ 5 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 5 │ 12 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - -``` -{% endtab %} -{% endtabs %} - -### Division works inplace - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24] -} - -let df = new dfd.DataFrame(data) -let val = [2, 2, 2, 2] - -df.div(val, { axis: 0, inplace: true }) - -df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 5 │ 11.5 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 22.5 │ 10 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 28 │ 5 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 5 │ 12 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - - -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.dropna.md b/api-reference-v1-stable/dataframe/danfo.dataframe.dropna.md deleted file mode 100644 index 429bcbe..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.dropna.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -description: Remove missing values (NaNs, undefined, null) for DataFrame ---- - -# DataFrame.dropna - -danfo.DataFrame.**dropna**(axis, options) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L1430)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ----------------------------------------------------------------------------------------------------------------------------- | -------------------- | -| axis | Int | 0 or 1. If 0, drop columns with NaNs, if 1, drop rows with NaNs | 1 | -| options | Object |inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
| {**inplace:** false} | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -### Drop rows (axis=0) with missing values - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = [[1, 2, 3], [NaN, 5, 6], [NaN, 30, 40], [39, undefined, 78]] -let cols = ["A", "B", "C"] -let df = new dfd.DataFrame(data, { columns: cols }) - -df.print() - -let df_drop = df.dropna(0) -df_drop.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 1 │ 2 │ 3 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Drop columns (axis=1) with missing values - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = [[1, 2, 3], [NaN, 5, 6], [NaN, 30, 40], [39, undefined, 78]] -let cols = ["A", "B", "C"] -let df = new dfd.DataFrame(data, { columns: cols }) - -df.print() - -df.dropna({axis: 1, inplace: true}) -df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╗ -║ │ C ║ -╟───┼───────────────────╢ -║ 0 │ 3 ║ -╟───┼───────────────────╢ -║ 1 │ 6 ║ -╟───┼───────────────────╢ -║ 2 │ 40 ║ -╟───┼───────────────────╢ -║ 3 │ 78 ║ -╚═══╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.eq.md b/api-reference-v1-stable/dataframe/danfo.dataframe.eq.md deleted file mode 100644 index 5f3cf2a..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.eq.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -description: Get Equal to of DataFrame and other, element-wise (binary operator eq). ---- - -# DataFrame.eq - -danfo.DataFrame.eq(other, option) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L1566)] - -| Parameters | Type | Description | Default | -| ---------- | -------------------------------- | ----------------------------------------------------------- | --------- | -| other | DataFrame, Series, Array, Scalar | Data structure, or array-like object to compare against | | -| option | Object | **axis**: 0 or 1. If 0, add column-wise, if 1, add row-wise | {axis: 1} | - -**Returns:** - -**** - -## **Examples** - -### Comparing **** DataFrame with a scalar value: - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24]} -let df = new dfd.DataFrame(data) - -let df_rep = df.eq(20) - -df_rep.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ false │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ false │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ false │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ false │ false ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Comparing **** DataFrame with a Series along the column axis: - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24]} -let df = new dfd.DataFrame(data) -let sf = new dfd.Series([10,40]) - -let df_rep = df.eq(sf, {axis:1}) - -df_rep.print() - - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```javascript -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ true │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ false │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ false │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ true │ false ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Comparing **** DataFrame with a DataFrame - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24]} -let data2 = {"new_col1": [10, 45, 200, 10], - "new_Col2": [230, 200, 110, 24]} - -let df = new dfd.DataFrame(data) -let df2 = new dfd.DataFrame(data2) - -let df_rep = df.eq(df2) - -df_rep.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```javascript -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ true │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ true │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ false │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ true │ true ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Comparing **** DataFrame with a JavaScript Array - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24]} -let df = new dfd.DataFrame(data) -let val = [10,40] - -let df_rep = df.eq(val, {axis:1}) - -df_rep.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```javascript -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ true │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ false │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ false │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ true │ false ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.fillna.md b/api-reference-v1-stable/dataframe/danfo.dataframe.fillna.md deleted file mode 100644 index 2ddb860..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.fillna.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -description: >- - Fill NaN/undefined values using the specified method. Detect missing values - for an array-like object. ---- - -# DataFrame.fillna - -danfo.DataFrame.**fillna**(values, options) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L1235)] - -| Parameters | Type | Description | Default | -| ---------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | -| values | Array \| Scalar | The list of value(s) to use for replacement. | | -| options | Object |{columns:Array of column name(s) to fill. If undefined fill all columns
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
}
| {inplace: false} | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -### Fill missing values in specified columns with specified values - -Missing values are NaN, undefined or null values - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Name": ["Apples", "Mango", "Banana", undefined], - "Count": [NaN, 5, NaN, 10], - "Price": [200, 300, 40, 250] -} - -let df = new dfd.DataFrame(data) -df.print() - -let values = ["Apples", df["Count"].mean()] -let df_filled = df.fillna(values, { columns: ["Name", "Count"] }) -df_filled.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -//Before filling -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Name │ Count │ Price ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ Apples │ NaN │ 200 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ Mango │ 5 │ 300 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ Banana │ NaN │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ NaN │ 10 │ 250 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - //After filling - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Name │ Count │ Price ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ Apples │ 7.5 │ 200 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ Mango │ 5 │ 300 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ Banana │ 7.5 │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ Apples │ 10 │ 250 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝═╝ -``` -{% endtab %} -{% endtabs %} - -### Fill all columns with NaNs with a specified value - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Name": ["Apples", "Mango", "Banana", undefined], - "Count": [NaN, 5, NaN, 10], - "Price": [200, 300, 40, 250] -} - -let df = new dfd.DataFrame(data) -let df_filled = df.fillna("Apples") - -df_filled.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Name │ Count │ Price ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ Apples │ Apples │ 200 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ Mango │ 5 │ 300 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ Banana │ Apples │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ Apples │ 10 │ 250 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Fill NaNs inplace - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") -let data = { - "Name": ["Apples", "Mango", "Banana", undefined], - "Count": [NaN, 5, NaN, 10], - "Price": [200, 300, 40, 250] -} - -let df = new dfd.DataFrame(data) -let values = ["Apples", df["Count"].mean()] -df.fillna(values, { - columns: ["Name", "Count"], - inplace: true -}) -df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Name │ Count │ Price ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ Apples │ Apples │ 200 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ Mango │ 5 │ 300 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ Banana │ Apples │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ Apples │ 10 │ 250 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.ge.md b/api-reference-v1-stable/dataframe/danfo.dataframe.ge.md deleted file mode 100644 index 8e5401b..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.ge.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -description: >- - Get Greater or Equal to of DataFrame and other, element-wise (binary operator - eq). ---- - -# DataFrame.ge - -danfo.DataFrame.ge(other, option) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L1566)] - -| Parameters | Type | Description | Default | -| ---------- | -------------------------------- | ----------------------------------------------------------- | --------- | -| other | DataFrame, Series, Array, Scalar | Data structure, or array-like object to compare against | | -| option | Object | **axis**: 0 or 1. If 0, add column-wise, if 1, add row-wise | {axis: 1} | - -**Returns:** - - **DataFrame** - -## **Examples** - -### Comparing **** DataFrame with a scalar value: - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24]} - -let df = new dfd.DataFrame(data) - -let df_rep = df.ge(20) - -df_rep.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ false │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ true │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ true │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ false │ true ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Comparing **** DataFrame with a Series along the column axis: - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24]} - -let df = new dfd.DataFrame(data) -let sf = new dfd.Series([10,40]) - -let df_rep = df.ge(sf, {axis:1}) - -df_rep.print() - - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```javascript -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ true │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ true │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ true │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ true │ false ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Comparing **** DataFrame with a DataFrame - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24]} -let data2 = {"new_col1": [10, 45, 200, 10], - "new_Col2": [230, 200, 110, 24]} - -let df = new dfd.DataFrame(data) -let df2 = new dfd.DataFrame(data2) - -let df_rep = df.ge(df2) - -df_rep.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```javascript -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ true │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ true │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ false │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ true │ true ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Comparing **** DataFrame with a JavaScript Array - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24]} -let df = new dfd.DataFrame(data) -let val = [10,40] - -let df_rep = df.ge(val, {axis:1}) - -df_rep.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```javascript -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ true │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ true │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ true │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ true │ false ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.groupby.md b/api-reference-v1-stable/dataframe/danfo.dataframe.groupby.md deleted file mode 100644 index e7d084f..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.groupby.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -description: Group DataFrame using a mapper or by a Series of columns. ---- - -# DataFrame.groupby - -danfo.DataFrame.**groupby**(columns) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L1142)] - -| Parameters | Type | Description | Default | -| ---------- | ----- | ----------------------------------------------------- | ------- | -| columns | Array | The names of a column(s) in the DataFrame to group by | | - -**Returns:** - - **** return **DataFrame.groups** - -## **Examples** - -## **Groupby a single column from a DataFrame** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = [["Pear", 2, 3], ["Pear", 5, 6], ["Apple", 30, 40], ["Apple", 89, 78]] -let cols = ["A", "B", "C"] - -let df = new dfd.DataFrame(data, { columns: cols }) -let group_df = df.groupby(["A"]) -console.log(group_df) - -//GroupBy Object -GroupBy { - key_col: [ 'A' ], - col_dict: { Pear: [ [Array], [Array] ], Apple: [ [Array], [Array] ] }, - data: [ - [ 'Pear', 2, 3 ], - [ 'Pear', 5, 6 ], - [ 'Apple', 30, 40 ], - [ 'Apple', 89, 78 ] - ], - column_name: [ 'A', 'B', 'C' ], - data_tensors: { - Pear: DataFrame { - '$isSeries': false, - '$config': [Configs], - '$data': [Array], - '$dataIncolumnFormat': [Array], - '$index': [Array], - '$dtypes': [Array], - '$columns': [Array] - }, - Apple: DataFrame { - '$isSeries': false, - '$config': [Configs], - '$data': [Array], - '$dataIncolumnFormat': [Array], - ... - '$columns': [Array] - } - }, - col_dtype: [ 'string' ] -} -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -A groupby operation will return a GroupBy class object. You can apply any of the following operation on the groupby result: - -1. [count](danfo.dataframe.count.md) -2. [sum](danfo.dataframe.sum.md) -3. [std](danfo.dataframe.std.md) -4. [var](danfo.dataframe.var.md) -5. [mean](danfo.dataframe.mean.md) -6. [cumsum](danfo.dataframe.cumsum.md) -7. [cummax](danfo.dataframe.cummax.md) -8. [cumprod](danfo.dataframe.cumprod.md) -9. [cummin](danfo.dataframe.cummin.md) -10. [max](danfo.dataframe.max.md) -11. [min](danfo.dataframe.min.md) - -## Example of Groupby and apply a sum function - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = [["Pear", 2, 3], ["Pear", 5, 6], ["Apple", 30, 40], ["Apple", 89, 78]] -let cols = ["A", "B", "C"] -let df = new dfd.DataFrame(data, { columns: cols }) -let group_df = df.groupby(["A"]).sum() - -group_df.print() - -``` -{% endtab %} -{% endtabs %} - -``` -╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B_sum │ C_sum ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ Pear │ 7 │ 9 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ Apple │ 119 │ 118 ║ -╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -## **Groupby a two columns from a DataFrame** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = [["Pear", 2, 3], ["Pear", 2, 6], ["Apple", 30, 40], ["Apple", 89, 78]] -let cols = ["A", "B", "C"] -let df = new dfd.DataFrame(data, { columns: cols }) -let group_df = df.groupby(["A", "B"]).sum() - -group_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -``` -╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_sum ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ Pear │ 2 │ 9 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ Apple │ 30 │ 40 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ Apple │ 89 │ 78 ║ -╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.gt.md b/api-reference-v1-stable/dataframe/danfo.dataframe.gt.md deleted file mode 100644 index ec3f7ba..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.gt.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -description: Get Greater than of DataFrame and other, element-wise (binary operator eq). ---- - -# DataFrame.gt - -danfo.DataFrame.g**t**(other, option) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L1566)] - -| Parameters | Type | Description | Default | -| ---------- | -------------------------------- | ----------------------------------------------------------- | --------- | -| other | DataFrame, Series, Array, Scalar | Data structure, or array-like object to compare against | | -| option | Object | **axis**: 0 or 1. If 0, add column-wise, if 1, add row-wise | {axis: 1} | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -### Comparing **** DataFrame with a scalar value: - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24]} -let df = new dfd.DataFrame(data) - -let df_rep = df.gt(20) - -df_rep.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ false │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ true │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ true │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ false │ true ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Comparing **** DataFrame with a Series along the column axis: - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24]} -let df = new dfd.DataFrame(data) -let sf = new dfd.Series([10,40]) - -let df_rep = df.gt(sf, {axis:1}) - -df_rep.print() - - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ false │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ true │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ true │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ false │ false ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Comparing **** DataFrame with a DataFrame - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24]} -let data2 = {"new_col1": [10, 45, 200, 10], - "new_Col2": [230, 200, 110, 24]} - -let df = new dfd.DataFrame(data) -let df2 = new dfd.DataFrame(data2) - -let df_rep = df.gt(df2) - -df_rep.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ false │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ false │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ false │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ false │ false ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Comparing **** DataFrame with a JavaScript Array - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24]} -let df = new dfd.DataFrame(data) -let val = [10,40] - -let df_rep = df.gt(val, axis=1) - -df_rep.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ false │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ true │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ true │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ false │ false ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.head.md b/api-reference-v1-stable/dataframe/danfo.dataframe.head.md deleted file mode 100644 index 3fe62c4..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.head.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -description: Returns the first n rows of the DataFrame based on position. ---- - -# DataFrame.head - -danfo.DataFrame.**head**(rows) \[[source](https://github.com/opensource9ja/danfojs/blob/fe56860b0a303d218d60ba71dee6abf594401556/danfojs/src/core/frame.js#L292)] - -| Parameters | Type | Description | Default | -| ---------- | ---- | ---------------------------- | ------- | -| rows | Int | The number of rows to return | 5 | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "Name": ["Apples", "Mango", "Banana", "Pear"], - "Count": [21, 5, 30, 10], - "Price": [200, 300, 40, 250] } - -let df = new dfd.DataFrame(data) -let s_df = df.head(2) -s_df.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Name │ Count │ Price ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ Apples │ 21 │ 200 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ Mango │ 5 │ 300 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.iloc.md b/api-reference-v1-stable/dataframe/danfo.dataframe.iloc.md deleted file mode 100644 index ffd7e25..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.iloc.md +++ /dev/null @@ -1,331 +0,0 @@ ---- -description: Purely integer-location based indexing for selection by position. ---- - -# DataFrame.iloc - -danfo.DataFrame.**iloc**(args) \[[source](https://github.com/opensource9ja/danfojs/blob/fe56860b0a303d218d60ba71dee6abf594401556/danfojs/src/core/frame.js#L254)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | -| args | Object |{
rows: Array, index of row position
columns: Array, index of position along columns
}
| | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -`.iloc()` is primarily integer position based (from `0` to `length-1` of the axis). - -Allowed inputs are: - -* An integer, e.g. `5`. -* A list or array of integers, e.g. `[4, 3, 0]`. -* A string slice object with ints, e.g. `"1:7"` -* A boolean array. - -_**Note:** only the start index is included._ - -`.iloc` will raise`IndexError` if a requested indexer is out-of-bounds. - -### **Indexing specific rows by index and return all columns** - -If the row's index is specified and the columns are not, then it returns all columns and just the specified rows. - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "Name": ["Apples", "Mango", "Banana", "Pear"], - "Count": [21, 5, 30, 10], - "Price": [200, 300, 40, 250] } - -let df = new dfd.DataFrame(data) -let sub_df = df.iloc({rows: [0,1,3]}) -sub_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Name │ Count │ Price ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ Apples │ 21 │ 200 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ Mango │ 5 │ 300 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ Pear │ 10 │ 250 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### **Index by a slice of row and return all columns** - -The [**iloc**](danfo.dataframe.iloc.md) function also accepts string slices of the form \[start: end], e.g "\[1: 3]". This will return all values between index position 1 and 3. The end index is not included. - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "Name": ["Apples", "Mango", "Banana", "Pear"], - "Count": [21, 5, 30, 10], - "Price": [200, 300, 40, 250] } - -let df = new dfd.DataFrame(data) -let sub_df = df.iloc({rows: ["1:3"]}) -sub_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Name │ Count │ Price ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ Mango │ 5 │ 300 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ Banana │ 30 │ 40 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### **Index by a slice of column and return all rows** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "Name": ["Apples", "Mango", "Banana", "Pear"], - "Count": [21, 5, 30, 10], - "Price": [200, 300, 40, 250] } - -let df = new dfd.DataFrame(data) -df.print() - -let sub_df = df.iloc({columns: ["1:"]}) -sub_df.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Name │ Count │ Price ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ Apples │ 21 │ 200 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ Mango │ 5 │ 300 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ Banana │ 30 │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ Pear │ 10 │ 250 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - Shape: (4,2) - -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Count │ Price ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ 21 │ 200 ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ 5 │ 300 ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ 30 │ 40 ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ 10 │ 250 ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Indexing both axes by the specified index - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "Name": ["Apples", "Mango", "Banana", "Pear"], - "Count": [21, 5, 30, 10], - "Price": [200, 300, 40, 250] } - -let df = new dfd.DataFrame(data) -let sub_df = df.iloc({rows: [0,3], columns: [1,2]}) -sub_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Name │ Count │ Price ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ Apples │ 21 │ 200 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ Mango │ 5 │ 300 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ Banana │ 30 │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ Pear │ 10 │ 250 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - //after indexing - -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Count │ Price ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ 21 │ 200 ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ 10 │ 250 ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Indexing both axes by slices - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "Name": ["Apples", "Mango", "Banana", "Pear"], - "Count": [21, 5, 30, 10], - "Price": [200, 300, 40, 250] } - -let df = new dfd.DataFrame(data) -df.print() - -let sub_df = df.iloc({rows: ["2:3"], columns: ["1:2"]}) -sub_df.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Name │ Count │ Price ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ Apples │ 21 │ 200 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ Mango │ 5 │ 300 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ Banana │ 30 │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ Pear │ 10 │ 250 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - - -╔═══╤═══════════════════╗ -║ │ Count ║ -╟───┼───────────────────╢ -║ 2 │ 30 ║ -╚═══╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### More default slicing behavior - -If you specify a slice start position, **iloc** automatically returns all values after that position. For instance: - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "Name": ["Apples", "Mango", "Banana", "Pear"], - "Count": [21, 5, 30, 10], - "Price": [200, 300, 40, 250] } - -let df = new dfd.DataFrame(data) -df.print() - -let sub_df = df.iloc({rows: ["2:"], columns: ["1:"]}) -sub_df.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Name │ Count │ Price ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ Apples │ 21 │ 200 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ Mango │ 5 │ 300 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ Banana │ 30 │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ Pear │ 10 │ 250 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - Shape: (2,2) - -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Count │ Price ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ 30 │ 40 ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ 10 │ 250 ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.isna.md b/api-reference-v1-stable/dataframe/danfo.dataframe.isna.md deleted file mode 100644 index 830bda5..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.isna.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: >- - Return a boolean same-sized object indicating if the values are NaN. - NaN/undefined values gets mapped to true values, and everything else gets - mapped to false values. ---- - -# DataFrame.isna - -danfo.DataFrame.**isna**(kwargs) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L1350)] - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = [[1, 2, 3], [NaN, 5, 6], [NaN, 30, 40], [39, undefined, 78]] -let cols = ["A", "B", "C"] -let df = new dfd.DataFrame(data, { columns: cols }) - -df.isna().print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ false │ false │ false ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ true │ false │ false ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ true │ false │ false ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ false │ true │ false ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.it.md b/api-reference-v1-stable/dataframe/danfo.dataframe.it.md deleted file mode 100644 index 3759197..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.it.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -description: Get Less than of DataFrame and other, element-wise (binary operator eq). ---- - -# DataFrame.It - -danfo.DataFrame.l**t**(other, option) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L1566)] - -| Parameters | Type | Description | Default | -| ---------- | -------------------------------- | ----------------------------------------------------------- | --------- | -| other | DataFrame, Series, Array, Scalar | Data structure, or array-like object to compare against | | -| option | Object | **axis**: 0 or 1. If 0, add column-wise, if 1, add row-wise | {axis: 1} | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -### Comparing **** DataFrame with a scalar value: - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24]} -let df = new dfd.DataFrame(data) - -let df_rep = df.lt(20) - -df_rep.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ true │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ false │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ false │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ true │ false ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Comparing **** DataFrame with a Series along the column axis: - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24] -} -let df = new dfd.DataFrame(data) -let sf = new dfd.Series([10, 40]) - -let df_rep = df.lt(sf, { axis: 1 }) - -df_rep.print() - - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ false │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ false │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ false │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ false │ true ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Comparing **** DataFrame with a DataFrame - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24]} -let data2 = {"new_col1": [10, 45, 200, 10], - "new_Col2": [230, 200, 110, 24]} - -let df = new dfd.DataFrame(data) -let df2 = new dfd.DataFrame(data2) - -let df_rep = df.lt(df2) - -df_rep.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ false │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ false │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ true │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ false │ false ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Comparing **** DataFrame with an Array - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24]} - -let df = new dfd.DataFrame(data) -let val = [10,40] - -let df_rep = df.lt(val, axis=1) - -df_rep.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ false │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ false │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ false │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ false │ true ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.le.md b/api-reference-v1-stable/dataframe/danfo.dataframe.le.md deleted file mode 100644 index 31ce3f7..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.le.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -description: >- - Get Less than or Equal to of DataFrame and other, element-wise (binary - operator eq). ---- - -# DataFrame.le - -danfo.DataFrame.le(other, option) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L1566)] - -| Parameters | Type | Description | Default | -| ---------- | -------------------------------- | ----------------------------------------------------------- | --------- | -| other | DataFrame, Series, Array, Scalar | Data structure, or array-like object to compare against | | -| option | Object | **axis**: 0 or 1. If 0, add column-wise, if 1, add row-wise | {axis: 1} | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -### Comparing **** DataFrame with a scalar value: - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24]} - -let df = new dfd.DataFrame(data) - -let df_rep = df.le(20) - -df_rep.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ true │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ false │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ false │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ true │ false ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Comparing **** DataFrame with a Series along the column axis: - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24]} - -let df = new dfd.DataFrame(data) -let sf = new dfd.Series([10,40]) - -let df_rep = df.le(sf, {axis:1}) - -df_rep.print() - - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ true │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ false │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ false │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ true │ true ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Comparing **** DataFrame with a DataFrame - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24]} -let data2 = {"new_col1": [10, 45, 200, 10], - "new_Col2": [230, 200, 110, 24]} - -let df = new dfd.DataFrame(data) -let df2 = new dfd.DataFrame(data2) - -let df_rep = df.le(df2) - -df_rep.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```javascript -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ true │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ true │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ true │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ true │ true ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Comparing **** DataFrame with an Array - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24]} -let df = new dfd.DataFrame(data) -let val = [10,40] - -let df_rep = df.le(val, {axis:1}) - -df_rep.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```javascript -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ true │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ false │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ false │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ true │ true ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.loc.md b/api-reference-v1-stable/dataframe/danfo.dataframe.loc.md deleted file mode 100644 index abdcdd9..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.loc.md +++ /dev/null @@ -1,367 +0,0 @@ ---- -description: Access a group of rows and columns by label(s) ---- - -# DataFrame.loc - -danfo.DataFrame.**loc**(args) \[[source](https://github.com/opensource9ja/danfojs/blob/cf5c7ae3a009458e61eedd18d9c9b5b6b10d5276/danfojs/src/core/frame.js#L125)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | -| args | Object |{
rows: Array, labels, Boolean mask of row index
columns: Array, labels of column names
}
| | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -`.loc()` is label position based-from `0` to `length-1` of the row axis. - -Allowed inputs for are: - -* An integer, e.g. `"r1"`. -* A list or array of integers, e.g. `["a", "b", "d"]`. -* A boolean mask. E.g \[ true, false, false ] -* A string slice object with ints, e.g. `[`'`"a":"d"'], ["1:4"]` - -_**Note:** only **** the start label is included, and the end label is ignored._ - -`.loc` will raise a `ValueEror` if a requested label is not found. - -### **Index by specific rows and return all columns** - -If the row's index is specified and the columns are not, then it returns all columns and just the specified rows. - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "Name": ["Apples", "Mango", "Banana", "Pear"], - "Count": [21, 5, 30, 10], - "Price": [200, 300, 40, 250] } - -let df = new dfd.DataFrame(data, {index: ["a", "b", "c", "d"]}) -df.print() -let sub_df = df.loc({rows: ["a", "c"]}) -sub_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Name │ Count │ Price ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ a │ Apples │ 21 │ 200 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ b │ Mango │ 5 │ 300 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ c │ Banana │ 30 │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ d │ Pear │ 10 │ 250 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - Shape: (2,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Name │ Count │ Price ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ a │ Apples │ 21 │ 200 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ c │ Banana │ 30 │ 40 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### **Index by a list of column names and return all rows** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "Name": ["Apples", "Mango", "Banana", "Pear"], - "Count": [21, 5, 30, 10], - "Price": [200, 300, 40, 250] } - -let df = new dfd.DataFrame(data, {index: ["a", "b", "c", "d"]}) -df.print() -let sub_df = df.loc({columns: ["Count", "Price"]}) -sub_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Name │ Count │ Price ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ a │ Apples │ 21 │ 200 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ b │ Mango │ 5 │ 300 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ c │ Banana │ 30 │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ d │ Pear │ 10 │ 250 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - //after indexing - -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Count │ Price ║ -╟───┼───────────────────┼───────────────────╢ -║ a │ 21 │ 200 ║ -╟───┼───────────────────┼───────────────────╢ -║ b │ 5 │ 300 ║ -╟───┼───────────────────┼───────────────────╢ -║ c │ 30 │ 40 ║ -╟───┼───────────────────┼───────────────────╢ -║ d │ 10 │ 250 ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Index both axes by the specified labels - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "Name": ["Apples", "Mango", "Banana", "Pear"], - "Count": [21, 5, 30, 10], - "Price": [200, 300, 40, 250] } - -let df = new dfd.DataFrame(data, { index: ["a", "b", "c", "d"] }) -df.print() -let sub_df = df.loc({ rows: ["c","d"], columns: ["Name", "Price"] }) -sub_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Name │ Count │ Price ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ a │ Apples │ 21 │ 200 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ b │ Mango │ 5 │ 300 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ c │ Banana │ 30 │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ d │ Pear │ 10 │ 250 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - - -//after slicing - -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Name │ Price ║ -╟───┼───────────────────┼───────────────────╢ -║ c │ Banana │ 40 ║ -╟───┼───────────────────┼───────────────────╢ -║ d │ Pear │ 250 ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -## **Index by a slice of row** - -The **loc** function also accepts string slices of the form \[start: end], e.g **\[\`"a":"c"\`]**. This will return all values from label positions `a` to c. - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "Name": ["Apples", "Mango", "Banana", "Pear"], - "Count": [21, 5, 30, 10], - "Price": [200, 300, 40, 250] } - -let df = new dfd.DataFrame(data, { index: ["a", "b", "c", "d"] }) -df.print() -let sub_df = df.loc({ rows: [`"a":"c"`], columns: ["Name", "Price"] }) -sub_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Name │ Count │ Price ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ a │ Apples │ 21 │ 200 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ b │ Mango │ 5 │ 300 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ c │ Banana │ 30 │ 40 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ d │ Pear │ 10 │ 250 ║ -╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Name │ Price ║ -╟────────────┼───────────────────┼───────────────────╢ -║ a │ Apples │ 200 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ b │ Mango │ 300 ║ -╚════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -{% hint style="info" %} -Note that when using loc with alphabetic slices. We expect you to pass labels in the correct format. That is, string labels must be explicitly quoted. For example, the following loc slice will throw an error:\ -df`.loc({ row: [a:e]}).print()`\ -For the slice above to work, you must quote each slice, e.g:\ -df``.loc({ row: [`"a":"e"`]}).print()``\ -\ -_**Inner**_ _**quotes are not needed for numeric indices!**_ -{% endhint %} - -### Slice DataFrame rows by boolean condition - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Name": ["Apples", "Mango", "Banana", "Pear"], - "Count": [21, 5, 30, 10], - "Price": [200, 300, 40, 250] -} - -let df = new dfd.DataFrame(data, { index: ["a", "b", "c", "d"] }) -let sub_df = df.loc({ rows: df["Count"].gt(6) }) -sub_df.print() -``` -{% endtab %} -{% endtabs %} - -``` -╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Name │ Count │ Price ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ a │ Apples │ 21 │ 200 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ c │ Banana │ 30 │ 40 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ d │ Pear │ 10 │ 250 ║ -╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - - -``` - -### Slice DataFrame rows by multiple boolean conditions - -{% hint style="info" %} -_By design, you can chain as many boolean logic as possible, as long as they resolve to a Boolean array of the same length as the DataFrame._ -{% endhint %} - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Name": ["Apples", "Mango", "Banana", "Pear"], - "Count": [21, 5, 30, 10], - "Price": [200, 300, 40, 250] -} - -let df = new dfd.DataFrame(data, { index: ["a", "b", "c", "d"] }) -let condition = df["Count"].gt(6).and(df["Price"].lt(250)) -let sub_df = df.loc({ rows: condition }) -sub_df.print() -``` -{% endtab %} -{% endtabs %} - -``` -╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Name │ Count │ Price ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ a │ Apples │ 21 │ 200 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ c │ Banana │ 30 │ 40 ║ -╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - -``` - -### Slice DataFrame with boolean mask - -{% hint style="info" %} -_You can index a DataFrame with an array of boolean values as long as they resolve to an array of the same length as the DataFrame._ -{% endhint %} - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Name": ["Apples", "Mango", "Banana", "Pear"], - "Count": [21, 5, 30, 10], - "Price": [200, 300, 40, 250] -} - -let df = new dfd.DataFrame(data, { index: ["a", "b", "c", "d"] }) - -let sub_df = df.loc({ rows: [false, true, true, true] }) -sub_df.print() -``` -{% endtab %} -{% endtabs %} - -``` -╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Name │ Count │ Price ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ b │ Mango │ 5 │ 300 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ c │ Banana │ 30 │ 40 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ d │ Pear │ 10 │ 250 ║ -╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - - -``` diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.max.md b/api-reference-v1-stable/dataframe/danfo.dataframe.max.md deleted file mode 100644 index a5c2119..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.max.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -description: Return the maximum of the values for the requested axis. ---- - -# DataFrame.max - -danfo.DataFrame.**max**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L454)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ----------------------------------------------------------------------------------- | ----------- | -| options | Object | **axis:** 0 or 1. If 0, compute the mean column-wise, if 1, row-wise. Defaults to 1 | { axis: 1 } | - -**Returns:** - - **** return **Series** - -## **Examples** - -## Return the maximum value along default axis 1 (column) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") -data = [[11, 20, 3], [1, 15, 6], [2, 30, 40], [2, 89, 78]] -cols = ["A", "B", "C"] - -df.print() - -let df = new dfd.DataFrame(data) -df.max().print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 11 │ 20 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 15 │ 6 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 2 │ 30 │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 2 │ 89 │ 78 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ A │ 11 ║ -╟───┼──────────────────────╢ -║ B │ 89 ║ -╟───┼──────────────────────╢ -║ C │ 78 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -## Return the maximum value along row axis (0) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") -data = [[11, 20, 3], [1, 15, 6], [2, 30, 40], [2, 89, 78]] -cols = ["A", "B", "C"] - -df.print() -let df = new dfd.DataFrame(data) -df.max({axis:0}).print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 11 │ 20 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 15 │ 6 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 2 │ 30 │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 2 │ 89 │ 78 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 20 ║ -╟───┼──────────────────────╢ -║ 1 │ 15 ║ -╟───┼──────────────────────╢ -║ 2 │ 40 ║ -╟───┼──────────────────────╢ -║ 3 │ 89 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.mean.md b/api-reference-v1-stable/dataframe/danfo.dataframe.mean.md deleted file mode 100644 index 172cff5..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.mean.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -description: Return the mean of the values for the requested axis. ---- - -# DataFrame.mean - -danfo.DataFrame.**mean**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L454)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ----------------------------------------------------------------------------------- | ----------- | -| options | Object | **axis:** 0 or 1. If 0, compute the mean column-wise, if 1, row-wise. Defaults to 1 | { axis: 1 } | - -**Returns:** - - **** return **Series** - -## **Examples** - -## Computes the mean of values along default axis 1 (column) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -data = [[11, 20, 3], [1, 15, 6], [2, 30, 40], [2, 89, 78]] -cols = ["A", "B", "C"] - -df.print() - -let df = new dfd.DataFrame(data) -df.mean().print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 11 │ 20 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 15 │ 6 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 2 │ 30 │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 2 │ 89 │ 78 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ A │ 4 ║ -╟───┼──────────────────────╢ -║ B │ 38.5 ║ -╟───┼──────────────────────╢ -║ C │ 31.75 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -## Computes the mean of values along row axis (0) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = [[11, 20, 3], [1, 15, 6], [2, 30, 40], [2, 89, 78]] -let cols = ["A", "B", "C"] - -df.print() -let df = new dfd.DataFrame(data) -df.mean({ axis: 0 }).print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 11 │ 20 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 15 │ 6 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 2 │ 30 │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 2 │ 89 │ 78 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 11.333333015441895 ║ -╟───┼──────────────────────╢ -║ 1 │ 7.333333492279053 ║ -╟───┼──────────────────────╢ -║ 2 │ 24 ║ -╟───┼──────────────────────╢ -║ 3 │ 56.33333206176758 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.median.md b/api-reference-v1-stable/dataframe/danfo.dataframe.median.md deleted file mode 100644 index 3e33583..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.median.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -description: Return the median of the values for the requested axis. ---- - -# DataFrame.median - -danfo.DataFrame.**median**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L454)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ----------------------------------------------------------------------------------- | ----------- | -| options | Object | **axis:** 0 or 1. If 0, compute the mean column-wise, if 1, row-wise. Defaults to 1 | { axis: 1 } | - -**Returns:** - - **** return **Series** - -## **Examples** - -## Calculates the median of values along default axis 1 (column) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -data = [[11, 20, 3], [1, 15, 6], [2, 30, 40], [2, 89, 78]] -cols = ["A", "B", "C"] - -df.print() - -let df = new dfd.DataFrame(data) -df.median().print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 11 │ 20 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 15 │ 6 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 2 │ 30 │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 2 │ 89 │ 78 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ A │ 2 ║ -╟───┼──────────────────────╢ -║ B │ 25 ║ -╟───┼──────────────────────╢ -║ C │ 23 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -## Calculates the median of values along row axis (0) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -data = [[11, 20, 3], [1, 15, 6], [2, 30, 40], [2, 89, 78]] -cols = ["A", "B", "C"] - -df.print() -let df = new dfd.DataFrame(data) -df.median({axis:0}).print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 11 │ 20 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 15 │ 6 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 2 │ 30 │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 2 │ 89 │ 78 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 11 ║ -╟───┼──────────────────────╢ -║ 1 │ 6 ║ -╟───┼──────────────────────╢ -║ 2 │ 30 ║ -╟───┼──────────────────────╢ -║ 3 │ 78 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.min.md b/api-reference-v1-stable/dataframe/danfo.dataframe.min.md deleted file mode 100644 index 49a13d6..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.min.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -description: Return the minimum of the values for the requested axis. ---- - -# DataFrame.min - -danfo.DataFrame.**min**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L454)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ----------------------------------------------------------------------------------- | ----------- | -| options | Object | **axis:** 0 or 1. If 0, compute the mean column-wise, if 1, row-wise. Defaults to 1 | { axis: 1 } | - -**Returns:** - - **** return **Series** - -## **Examples** - -## Returns the minimum value along default axis 1 (column) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -data = [[11, 20, 3], [1, 15, 6], [2, 30, 40], [2, 89, 78]] -cols = ["A", "B", "C"] - -df.print() - -let df = new dfd.DataFrame(data) -df.min().print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 11 │ 20 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 15 │ 6 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 2 │ 30 │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 2 │ 89 │ 78 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ A │ 1 ║ -╟───┼──────────────────────╢ -║ B │ 15 ║ -╟───┼──────────────────────╢ -║ C │ 3 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -## Return the minimum value along row axis (0) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -data = [[11, 20, 3], [1, 15, 6], [2, 30, 40], [2, 89, 78]] -cols = ["A", "B", "C"] - -df.print() -let df = new dfd.DataFrame(data) -df.min({axis: 0}).print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 11 │ 20 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 15 │ 6 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 2 │ 30 │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 2 │ 89 │ 78 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 3 ║ -╟───┼──────────────────────╢ -║ 1 │ 1 ║ -╟───┼──────────────────────╢ -║ 2 │ 2 ║ -╟───┼──────────────────────╢ -║ 3 │ 2 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.mod.md b/api-reference-v1-stable/dataframe/danfo.dataframe.mod.md deleted file mode 100644 index 18558e6..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.mod.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -description: Get Modulo of DataFrame and other, element-wise (binary operator mod). ---- - -# DataFrame.mod - -danfo.DataFrame.mod(other, option) \[[source](https://github.com/opensource9ja/danfojs/blob/fe56860b0a303d218d60ba71dee6abf594401556/danfojs/src/core/frame.js#L347)] - -| Parameters | Type | Description | Default | -| ---------- | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| other | DataFrame, Series, Array or Scalar | Object to add with | | -| option | Object |{
axis: 0 for row, 1 for column.
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
}
| { axis: 1, inplace: false } | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -### Modulo of **scalar with** DataFrame along default axis 1 - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24] -} -let df = new dfd.DataFrame(data) - -let df_new = df.mod(2) - -df_new.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 0 │ 1 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 0 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 0 │ 0 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 0 │ 0 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - - - -``` -{% endtab %} -{% endtabs %} - -### Modulo of **Series with** DataFrame along axis 0 - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [1, 4, 5, 1], - "Col2": [3, 2, 0, 4] -} - -let df = new dfd.DataFrame(data) -let sf = new dfd.Series([4, 5]) - -let df_new = df.mod(sf, { axis: 1 }) - -df_new.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 1 │ 3 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 0 │ 2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 1 │ 0 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 1 │ 4 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - - - -``` -{% endtab %} -{% endtabs %} - -### Modulo of **** DataFrame with a DataFrame - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs") - -let data = {"Col1": [1, 4, 5, 0], - "Col2": [2, 0, 1, 4]} - -let data2 = {"new_col1": [1, 5, 20, 10], - "new_Col2": [20, 2, 1, 2]} - -let df = new dfd.DataFrame(data) -let df2 = new dfd.DataFrame(data2) - -let df_new = df.mod(df2) - -df_new.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 0 │ 2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 4 │ 0 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 5 │ 0 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 0 │ 0 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - - - -``` -{% endtab %} -{% endtabs %} - -### Modulo of **** Array with DataFrame along axis 0 - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24] -} - -let df = new dfd.DataFrame(data) -let val = [2, 2, 2, 2] - -let df_new = df.mod(val, { axis: 0 }) - -df_new.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 0 │ 1 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 0 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 0 │ 0 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 0 │ 0 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - - -``` -{% endtab %} -{% endtabs %} - -### Modulo works inplace - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24] -} - -let df = new dfd.DataFrame(data) -let val = [2, 2, 2, 2] - -df.mod(val, { axis: 0, inplace: true }) - -df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 0 │ 1 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 0 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 0 │ 0 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 0 │ 0 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - - - -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.mul.md b/api-reference-v1-stable/dataframe/danfo.dataframe.mul.md deleted file mode 100644 index 3303d77..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.mul.md +++ /dev/null @@ -1,252 +0,0 @@ ---- -description: Get Multiplication of dataframe and other, element-wise (binary operator mul). ---- - -# DataFrame.mul - -danfo.DataFrame.mul(other, option) \[[source](https://github.com/opensource9ja/danfojs/blob/fe56860b0a303d218d60ba71dee6abf594401556/danfojs/src/core/frame.js#L347)] - -| Parameters | Type | Description | Default | -| ---------- | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| other | DataFrame, Series, Array or Scalar | Object to add with | | -| option | Object |{
axis: 0 for row, 1 for column.
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
}
| { axis: 1, inplace: false } | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -### Multiplication of **scalar to** DataFrame along default axis 1 - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24] -} -let df = new dfd.DataFrame(data) - -let df_new = df.mul(2) - -df_new.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 20 │ 46 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 90 │ 40 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 112 │ 20 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 20 │ 48 ║ -╚════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Multiplication of **Series to** DataFrame along axis 0 - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [1, 4, 5, 1], - "Col2": [3, 2, 0, 4] -} - -let df = new dfd.DataFrame(data) -let sf = new dfd.Series([4, 5]) - -let df_new = df.mul(sf, { axis: 1 }) - -df_new.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 4 │ 15 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 16 │ 10 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 20 │ 0 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 4 │ 20 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - -``` -{% endtab %} -{% endtabs %} - -### Multiplication of **** DataFrame to a DataFrame - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs") - -let data = {"Col1": [1, 4, 5, 0], - "Col2": [2, 0, 1, 4]} - -let data2 = {"new_col1": [1, 5, 20, 10], - "new_Col2": [20, 2, 1, 2]} - -let df = new dfd.DataFrame(data) -let df2 = new dfd.DataFrame(data2) - -let df_new = df.mul(df2) - -df_new.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 1 │ 40 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 20 │ 0 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 100 │ 1 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 0 │ 8 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - - -``` -{% endtab %} -{% endtabs %} - -### Multiplication of **** Array to DataFrame along axis 0 - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24] -} - -let df = new dfd.DataFrame(data) -let val = [2, 2, 2, 2] - -let df_new = df.mul(val, { axis: 0 }) - -df_new.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 20 │ 46 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 90 │ 40 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 112 │ 20 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 20 │ 48 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - - - -``` -{% endtab %} -{% endtabs %} - -### Multiplication works inplace - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24] -} - -let df = new dfd.DataFrame(data) -let val = [2, 2, 2, 2] - -df.mul(val, { axis: 0, inplace: true }) - -df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 20 │ 46 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 90 │ 40 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 112 │ 20 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 20 │ 48 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - - -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.ne.md b/api-reference-v1-stable/dataframe/danfo.dataframe.ne.md deleted file mode 100644 index dd45cf0..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.ne.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -description: Get Not Equal to of DataFrame and other, element-wise (binary operator eq). ---- - -# DataFrame.ne - -danfo.DataFrame.ne(other, option) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L1566)] - -| Parameters | Type | Description | Default | -| ---------- | -------------------------------- | ----------------------------------------------------------- | --------- | -| other | DataFrame, Series, Array, Scalar | Data structure, or array-like object to compare against | | -| option | Object | **axis**: 0 or 1. If 0, add column-wise, if 1, add row-wise | {axis: 1} | - -**Returns:** - -**** - -## **Examples** - -### Comparing **** DataFrame with a scalar value: - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24]} -let df = new dfd.DataFrame(data) - -let df_rep = df.ne(20) - -df_rep.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ true │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ true │ false ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ true │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ true │ true ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Comparing **** DataFrame with a Series along the column axis: - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24]} -let df = new dfd.DataFrame(data) -let sf = new dfd.Series([10,40]) - -let df_rep = df.ne(sf, {axis:1}) - -df_rep.print() - - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ false │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ true │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ true │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ false │ true ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Comparing **** DataFrame with a DataFrame - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24]} -let data2 = {"new_col1": [10, 45, 200, 10], - "new_Col2": [230, 200, 110, 24]} - -let df = new dfd.DataFrame(data) -let df2 = new dfd.DataFrame(data2) - -let df_rep = df.ne(df2) - -df_rep.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ false │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ false │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ true │ true ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ false │ false ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Comparing **** DataFrame with a JavaScript Array - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24]} -let df = new dfd.DataFrame(data) -let val = [10, 40, 30, 20] - -let df_rep = df.le(val) - -df_rep.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ 0 │ 1 │ 2 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ true │ false │ false │ true ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ false │ true │ true │ false ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.pow.md b/api-reference-v1-stable/dataframe/danfo.dataframe.pow.md deleted file mode 100644 index e6f1e6c..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.pow.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -description: >- - Get Exponential power of dataframe and other, element-wise (binary operator - pow). ---- - -# DataFrame.pow - -danfo.DataFrame.pow(other, option) \[[source](https://github.com/opensource9ja/danfojs/blob/fe56860b0a303d218d60ba71dee6abf594401556/danfojs/src/core/frame.js#L347)] - -| Parameters | Type | Description | Default | -| ---------- | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| other | DataFrame, Series, Array or Scalar | Object to add with | | -| option | Object |{
axis: 0 for row, 1 for column.
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
}
| { axis: 1, inplace: false } | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -### Exponential of **scalar with** DataFrame along default axis 1 - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24] -} -let df = new dfd.DataFrame(data) - -let df_new = df.pow(2) - -df_new.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 100 │ 529 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 2025 │ 400 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 3136 │ 100 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 100 │ 576 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - - - -``` -{% endtab %} -{% endtabs %} - -### Exponential of **Series with** DataFrame along axis 0 - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [1, 4, 5, 1], - "Col2": [3, 2, 0, 4] -} - -let df = new dfd.DataFrame(data) -let sf = new dfd.Series([4, 5]) - -let df_new = df.pow(sf, { axis: 1 }) - -df_new.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 1 │ 243 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 256 │ 32 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 625 │ 0 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 1 │ 1024 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - - - -``` -{% endtab %} -{% endtabs %} - -### Exponential of **** DataFrame with a DataFrame - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs") - -let data = {"Col1": [1, 4, 5, 0], - "Col2": [2, 0, 1, 4]} - -let data2 = {"new_col1": [1, 5, 20, 10], - "new_Col2": [20, 2, 1, 2]} - -let df = new dfd.DataFrame(data) -let df2 = new dfd.DataFrame(data2) - -let df_new = df.pow(df2) - -df_new.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 1 │ 1048576 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1024 │ 0 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 95367433551872 │ 1 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 0 │ 16 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - - - -``` -{% endtab %} -{% endtabs %} - -### Exponential of **** Array with DataFrame along axis 0 - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24] -} - -let df = new dfd.DataFrame(data) -let val = [2, 2, 2, 2] - -let df_new = df.pow(val, { axis: 0 }) - -df_new.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 100 │ 529 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 2025 │ 400 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 3136 │ 100 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 100 │ 576 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - - -``` -{% endtab %} -{% endtabs %} - -### Exponential works inplace - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24] -} - -let df = new dfd.DataFrame(data) -let val = [2, 2, 2, 2] - -df.pow(val, { axis: 0, inplace: true }) - -df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 100 │ 529 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 2025 │ 400 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 3136 │ 100 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 100 │ 576 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - - - -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.query.md b/api-reference-v1-stable/dataframe/danfo.dataframe.query.md deleted file mode 100644 index 129c8e7..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.query.md +++ /dev/null @@ -1,278 +0,0 @@ ---- -description: >- - Query the DataFrame by the result of a logical comparison or boolean mask. - Supports logical operations like (">", "<", ">=", "<=", and. "==") ---- - -# DataFrame.query - -danfo.DataFrame.**query**(kwargs) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L1011)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------- | -| kwargs | Object |{
condition: A logical boolean mask,
column : str, name of the column
is: Logical operator, one of ">", "<", ">=", "<=", and. "=="
to: Int, Float, Str. Value to compare against,
inplace: boolean. true | false. Whether to perform operation to the original Object or create a new one.
}
| {**inplace**: false} | - -**Returns:** - - **** return **new DataFrame** - -## **Examples** - -## **Query a DataFrame using a boolean mask** - -{% hint style="info" %} -Querying by a boolean condition is supported from v0.3.0 and above. -{% endhint %} - -```javascript -let data = { - "A": ["Ng", "Yu", "Mo", "Ng"], - "B": [34, 4, 5, 6], - "C": [20, 20, 30, 40] -} -let df = new dfd.DataFrame(data) - -let query_df = df.query({ condition: df["B"].gt(5) }) -query_df.print() //after query -``` - -``` -╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 20 │ 30 │ 40 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 39 │ 89 │ 78 ║ -╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -It also supports condition chaining as long as the final boolean mask is the same lenght as the DataFrame rows. For example in the following code, we use multiple chaining conditions: - -```javascript -let data = { - "A": ["Ng", "Yu", "Mo", "Ng"], - "B": [34, 4, 5, 6], - "C": [20, 20, 30, 40] -} -let df = new dfd.DataFrame(data) - -let query_df = df.query({ condition: df["B"].gt(5).and(df["C"].lt(40)) }) -query_df.print() //after query - -//output -╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ Ng │ 34 │ 20 ║ -╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - - -``` - -## **Query a DataFrame using logical operators** - -To query a DataFrame, you can specify the column to use, the logical operator (">", "<", ">=", "<=", and. "=="), and the value to compare against. - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"A": [30, 1, 2, 3], - "B": [34, 4, 5, 6], - "C": [20, 20, 30, 40]} - -let cols = ["A", "B", "C"] -let df = new dfd.DataFrame(data, { columns: cols }) -df.print() //before query - -let query_df = df.query({ "column": "B", "is": ">", "to": 5 }) -query_df.print() //after query -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -//before query -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 1 │ 2 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 4 │ 5 │ 6 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 20 │ 30 │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 39 │ 89 │ 78 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - -//after query -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 20 │ 30 │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 39 │ 89 │ 78 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") -let data = {"A": [30, 1, 2, 3], - "B": [34, 4, 5, 6], - "C": [20, 20, 30, 40]} - -let df = new dfd.DataFrame(data) - -df.print() - -let query_df = df.query({ "column": "A", "is": ">", "to": 9 }) -query_df.print() //after query - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 30 │ 34 │ 20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 4 │ 20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 2 │ 5 │ 30 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 3 │ 6 │ 40 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - -//after query - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 30 │ 34 │ 20 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -## **Query by a string column in a DataFrame** - -The query method also works on string columns. - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") -let data = {"A": ["Ng", "Yu", "Mo", "Ng"], - "B": [34, 4, 5, 6], - "C": [20, 20, 30, 40]} - -let df = new dfd.DataFrame(data) - -df.print() - -let query_df = df.query({ column: "A", is: "==", to: "Ng"}) -query_df.print() //after query - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ Ng │ 34 │ 20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ Yu │ 4 │ 20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ Mo │ 5 │ 30 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ Ng │ 6 │ 40 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - -//after query - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ Ng │ 34 │ 20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ Ng │ 6 │ 40 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -## **Query a DataFrame inplace** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"A": [30, 1, 2, 3], - "B": [34, 4, 5, 6], - "C": [20, 20, 30, 40]} - -let cols = ["A", "B", "C"] -let df = new dfd.DataFrame(data, { columns: cols }) - -df.query({ - column: "B", - is: ">", - to: 5, - inplace: true -}) -df.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 30 │ 34 │ 20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 3 │ 6 │ 40 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.replace.md b/api-reference-v1-stable/dataframe/danfo.dataframe.replace.md deleted file mode 100644 index 82fa16d..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.replace.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -description: Replaces values in a DataFrame with specified values ---- - -# DataFrame.replace - -> danfo.DataFrame.**replace**(oldValue, newValue, options) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L1670)] - -| Parameters | Type | Description | Default | -| ---------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- | -| oldValue | String, boolean, Number | The value you want to replace | | -| newValue | String, boolean, Number | The new value you want to replace the old value with | | -| options | Object |columns: Array. An array of column names to replace, If not specified, replace all columns.
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
| {inplace: false} | - -**Returns:** - - **** return **DataFrame** - -**** - -## **Examples** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24] -} -let df = new dfd.DataFrame(data) - -let df_rep = df.replace(10, -999, { columns: ["Col1"] }) - -df_rep.print() - - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ -999 │ 23 ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ 45 │ 20 ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ 56 │ 10 ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ -999 │ 24 ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -By not specifying a **** column**,** the **** replace works on all columns **** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = [["A", "A", "A", "B"], ["B", "C", "C", "D"]] -let df = new dfd.DataFrame(data) -//replace value in all column -let df_rep = df.replace("A", "BOY") - -df_rep.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```javascript - -╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ 0 │ 1 │ 2 │ 3 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ BOY │ BOY │ BOY │ B ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ B │ C │ C │ D ║ -╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.round.md b/api-reference-v1-stable/dataframe/danfo.dataframe.round.md deleted file mode 100644 index e12cb52..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.round.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -description: Round elements in a DataFrame to a specified number of decimal places. ---- - -# DataFrame.round - -danfo.DataFrame.**round**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L454)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | -------------------------------------------------------------------------------------------------- | ------------------ | -| dp | Int | Number of decimal places to round to. Defaults to 1 | 1 | -| options | Object | **inplace:** Boolean indicating whether to perform the operation inplace or not. Defaults to false | { inplace: false } | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -## Round elements to 1dp (Default) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -data = [[11.20, 20.1234, 3.567], [1, 15.1, 6.0], [2, 3.09, 40.234]] -cols = ["A", "B", "C"] - -let df = new dfd.DataFrame(data, { columns: cols }) -df.print() - -let new_df = df.round() - -new_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 11.2 │ 20.1234 │ 3.567 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 15.1 │ 6 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 2 │ 3.09 │ 40.234 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - //after round - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 11.2 │ 20.1 │ 3.6 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 15.1 │ 6 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 2 │ 3.1 │ 40.2 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -## Round elements to a specified number of decimal places - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -data = [[11.20, 20.1234, 3.567], [1, 15.1, 6.0], [2, 3.09, 40.234]] -cols = ["A", "B", "C"] - -let df = new dfd.DataFrame(data, { columns: cols }) -df.print() - -let new_df = df.round(2) - -new_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 11.2 │ 20.1234 │ 3.567 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 15.1 │ 6 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 2 │ 3.09 │ 40.234 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - //after round operation - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 11.2 │ 20.12 │ 3.57 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 1 │ 15.1 │ 6 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 2 │ 3.09 │ 40.23 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -## diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.sample.md b/api-reference-v1-stable/dataframe/danfo.dataframe.sample.md deleted file mode 100644 index b8a4c96..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.sample.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -description: Return a random sample of rows from DataFrame. ---- - -# DataFrame.sample - -danfo.DataFrame.**sample**(num, seed) \[[source](https://github.com/opensource9ja/danfojs/blob/fe56860b0a303d218d60ba71dee6abf594401556/danfojs/src/core/frame.js#L314)] - -| Parameters | Type | Description | Default | -| ---------- | ---- | ---------------------------------------------------------------------------------------------------------------------------------- | ------- | -| num | Int | The number of rows to return. Defaults to -1, which shuffles and return all rows. | -1 | -| seed | int | An integer specifying the random seed that will be used to create the distribution. Ensures reproducibility of generated samples. | 1 | - -**Returns:** - - **** return **{Promies} resolves to DataFrame** - -**** - -## Sample a DataFrame randomly - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -async function load_data() { - let data = { - Name: ["Apples", "Mango", "Banana", "Pear"], - Count: [21, 5, 30, 10], - Price: [200, 300, 40, 250], - }; - - let df = new dfd.DataFrame(data); - let s_df = await df.sample(2); - s_df.print(); - -} - -load_data() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Name │ Count │ Price ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ Apples │ 21 │ 200 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ Banana │ 30 │ 40 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -## Sample a DataFrame randomly with seed - -By setting `seed` when using `sample`, you can ensure that the random sampling is reproducible. - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -async function load_data() { - let data = { - Name: ["Apples", "Mango", "Banana", "Pear"], - Count: [21, 5, 30, 10], - Price: [200, 300, 40, 250], - }; - - let df = new dfd.DataFrame(data); - let s_df = await df.sample(3, { seed: 2 }); - s_df.print(); - -} - -load_data() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Name │ Count │ Price ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ Mango │ 5 │ 300 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ Banana │ 30 │ 40 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ Apples │ 21 │ 200 ║ -╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - - -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.std.md b/api-reference-v1-stable/dataframe/danfo.dataframe.std.md deleted file mode 100644 index 1a37e2e..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.std.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -description: Return sample standard deviation over requested axis. ---- - -# DataFrame.std - -danfo.DataFrame.**std**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L454)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ----------------------------------------------------------------------------------- | ----------- | -| options | Object | **axis:** 0 or 1. If 0, compute the mean column-wise, if 1, row-wise. Defaults to 1 | { axis: 1 } | - -**Returns:** - - **** return **Series** - -## **Examples** - -## Calculates the standard deviation of values along default axis 1 (column) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") -data = [[11, 20, 3], [1, 15, 6], [2, 30, 40], [2, 89, 78]] -cols = ["A", "B", "C"] - -let df = new dfd.DataFrame(data) -df.std().print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 4.69041575982343 ║ -╟───┼──────────────────────╢ -║ 1 │ 34.23935357645254 ║ -╟───┼──────────────────────╢ -║ 2 │ 35.103418636936205 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -## Calculates the standard deviation of values along row axis (0) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") -data = [[11, 20, 3], [1, 15, 6], [2, 30, 40], [2, 89, 78]] -cols = ["A", "B", "C"] - -let df = new dfd.DataFrame(data) -df.std({axis:0}).print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 8.504900548115383 ║ -╟───┼──────────────────────╢ -║ 1 │ 7.094598884597588 ║ -╟───┼──────────────────────╢ -║ 2 │ 19.697715603592208 ║ -╟───┼──────────────────────╢ -║ 3 │ 47.37439533475159 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -## - diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.sub.md b/api-reference-v1-stable/dataframe/danfo.dataframe.sub.md deleted file mode 100644 index e36ddcc..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.sub.md +++ /dev/null @@ -1,250 +0,0 @@ ---- -description: Get Subtraction of dataframe and other, element-wise (binary operator sub). ---- - -# DataFrame.sub - -danfo.DataFrame.sub(other, option) \[[source](https://github.com/opensource9ja/danfojs/blob/fe56860b0a303d218d60ba71dee6abf594401556/danfojs/src/core/frame.js#L347)] - -| Parameters | Type | Description | Default | -| ---------- | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| other | DataFrame, Series, Array or Scalar | Object to add with | | -| option | Object |{
axis: 0 for row, 1 for column.
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
}
| { axis: 1, inplace: false } | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -### Subtraction of **scalar to** DataFrame along default axis 1 - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24] -} -let df = new dfd.DataFrame(data) - -let df_new = df.sub(2) - -df_new.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 8 │ 21 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 43 │ 18 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 54 │ 8 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 8 │ 22 ║ -╚════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Subtraction of **Series to** DataFrame along axis 0 - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [1, 4, 5, 1], - "Col2": [3, 2, 0, 4] -} - -let df = new dfd.DataFrame(data) -let sf = new dfd.Series([4, 5]) - -let df_new = df.sub(sf, { axis: 1 }) - -df_new.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ -3 │ -2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 0 │ -3 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 1 │ -5 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ -3 │ -1 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - -``` -{% endtab %} -{% endtabs %} - -### Subtraction of **** DataFrame to a DataFrame - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs") - -let data = {"Col1": [1, 4, 5, 0], - "Col2": [2, 0, 1, 4]} - -let data2 = {"new_col1": [1, 5, 20, 10], - "new_Col2": [20, 2, 1, 2]} - -let df = new dfd.DataFrame(data) -let df2 = new dfd.DataFrame(data2) - -let df_new = df.sub(df2) - -df_new.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 0 │ -18 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ -1 │ -2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ -15 │ 0 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ -10 │ 2 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - -``` -{% endtab %} -{% endtabs %} - -### Subtraction of **** Array to DataFrame along axis 0 - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24] -} - -let df = new dfd.DataFrame(data) -let val = [2, 2, 2, 2] - -let df_new = df.sub(val, { axis: 0 }) - -df_new.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 8 │ 21 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 43 │ 18 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 54 │ 8 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 8 │ 22 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - - -``` -{% endtab %} -{% endtabs %} - -### Subtraction works inplace - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "Col1": [10, 45, 56, 10], - "Col2": [23, 20, 10, 24] -} - -let df = new dfd.DataFrame(data) -let val = [2, 2, 2, 2] - -df.sub(val, { axis: 0, inplace: true }) - -df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ Col1 │ Col2 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ 8 │ 21 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ 43 │ 18 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ 54 │ 8 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ 8 │ 22 ║ -╚════════════╧═══════════════════╧═══════════════════╝ - - -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.sum.md b/api-reference-v1-stable/dataframe/danfo.dataframe.sum.md deleted file mode 100644 index 3937d3f..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.sum.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -description: Return the sum of the values for the requested axis. ---- - -# DataFrame.sum - -danfo.DataFrame.**sum**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L454)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ----------------------------------------------------------------------------------- | ----------- | -| options | Object | **axis:** 0 or 1. If 0, compute the mean column-wise, if 1, row-wise. Defaults to 1 | { axis: 1 } | - -**Returns:** - - **** return **Series** - -## **Examples** - -## Sum elements along default axis (column) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") -let data = {"A": [-20.1, 30, 47.3, -20], - "B": [34, -4, 5, 6], - "C": [20, -20, 30, -40]} -let df = new dfd.DataFrame(data) - -df.print() - -let df_sum = df.sum() -df_sum.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ -20.1 │ 34 │ 20 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 30 │ -4 │ -20 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 47.3 │ 5 │ 30 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ -20 │ 6 │ -40 ║ -╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - -╔═══╤════════════════════╗ -║ A │ 37.199999999999996 ║ -╟───┼────────────────────╢ -║ B │ 41 ║ -╟───┼────────────────────╢ -║ C │ -10 ║ -╚═══╧════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -## Sum elements along row axis (0) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") -let data = {"A": [-20.1, 30, 47.3, -20], - "B": [34, -4, 5, 6], - "C": [20, -20, 30, -40]} -let df = new dfd.DataFrame(data) - -df.print() - -let df_sum = df.sum({axis: 0}) -df_sum.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ -20.1 │ 34 │ 20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 30 │ -4 │ -20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 47.3 │ 5 │ 30 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ -20 │ 6 │ -40 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - -╔═══╤══════════════════════╗ -║ │ sum ║ -╟───┼──────────────────────╢ -║ 0 │ 33.9 ║ -╟───┼──────────────────────╢ -║ 1 │ 6 ║ -╟───┼──────────────────────╢ -║ 2 │ 82.3 ║ -╟───┼──────────────────────╢ -║ 3 │ -54 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.tail.md b/api-reference-v1-stable/dataframe/danfo.dataframe.tail.md deleted file mode 100644 index 165acac..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.tail.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -description: Returns the last n rows from the DataFrame based on position. ---- - -# DataFrame.tail - -danfo.DataFrame.**tail**(rows) \[[source](https://github.com/opensource9ja/danfojs/blob/fe56860b0a303d218d60ba71dee6abf594401556/danfojs/src/core/frame.js#L292)] - -| Parameters | Type | Description | Default | -| ---------- | ---- | ---------------------------- | ------- | -| rows | Int | The number of rows to return | 5 | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "Name": ["Apples", "Mango", "Banana", "Pear"], - "Count": [21, 5, 30, 10], - "Price": [200, 300, 40, 250] } - -let df = new dfd.DataFrame(data) -let s_df = df.tail(3) -s_df.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Name │ Count │ Price ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ Banana │ 30 │ 40 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ Pear │ 10 │ 250 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/danfo.dataframe.var.md b/api-reference-v1-stable/dataframe/danfo.dataframe.var.md deleted file mode 100644 index ea0daf2..0000000 --- a/api-reference-v1-stable/dataframe/danfo.dataframe.var.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -description: Return unbiased variance over requested axis. ---- - -# DataFrame.var - -danfo.DataFrame.**var**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L454)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ----------------------------------------------------------------------------------- | ----------- | -| options | Object | **axis:** 0 or 1. If 0, compute the mean column-wise, if 1, row-wise. Defaults to 1 | { axis: 1 } | - -**Returns:** - - **** return **Series** - -## **Examples** - -## Calculate variance of values along default axis 1 (column) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") -data = [[11, 20, 3], [1, 15, 6], [2, 30, 40], [2, 89, 78]] -cols = ["A", "B", "C"] - -let df = new dfd.DataFrame(data) -df.var().print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 22 ║ -╟───┼──────────────────────╢ -║ 1 │ 1172.3333333333333 ║ -╟───┼──────────────────────╢ -║ 2 │ 1232.25 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -## Calculate variance of values along row axis (0) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") -data = [[11, 20, 3], [1, 15, 6], [2, 30, 40], [2, 89, 78]] -cols = ["A", "B", "C"] - -let df = new dfd.DataFrame(data) -df.var({axis:0}).print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 72.33333333333334 ║ -╟───┼──────────────────────╢ -║ 1 │ 50.33333333333333 ║ -╟───┼──────────────────────╢ -║ 2 │ 388 ║ -╟───┼──────────────────────╢ -║ 3 │ 2244.333333333333 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - - - diff --git a/api-reference-v1-stable/dataframe/dataframe.append.md b/api-reference-v1-stable/dataframe/dataframe.append.md deleted file mode 100644 index bc2e29d..0000000 --- a/api-reference-v1-stable/dataframe/dataframe.append.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -description: Adds new row to the end of a DataFrame ---- - -# DataFrame.append - -danfo.DataFrame.**append**(val) \[[source](https://github.com/opensource9ja/danfojs/blob/2696f1d8420dd364464aae7c5c175c6cd0ef4c93/danfojs/src/core/frame.js#L2059)] - -| Parameters | Type | Description | Default | -| ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------- | -| newValues | Array, Series or DataFrame | Value to append to the DataFrame | | -| index | Array | The new index value(s) to append to the Series. Must contain the same number of values as`newValues` as they map `1 - 1`. | | -| options | Object |Optional parameters
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
|{
inplace : false
}
| - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -### **Appends a new row to the end of a DataFrame** - -{% tabs %} -{% tab title="Node" %} -```javascript -let data = [[0, 2, 4, "b"], - [360, 180, 360, "a"], - [2, 4, 6, "c"]] - -let df = new dfd.DataFrame(data) -df.print() - -let new_df = df.append([[20, 40, 60, "d"]], [3]) -new_df.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ 0 │ 1 │ 2 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 0 │ 2 │ 4 │ b ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 360 │ 180 │ 360 │ a ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 2 │ 4 │ 6 │ c ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - Shape: (4,4) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ 0 │ 1 │ 2 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 0 │ 2 │ 4 │ b ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 360 │ 180 │ 360 │ a ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 2 │ 4 │ 6 │ c ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 20 │ 40 │ 60 │ d ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -**** diff --git a/api-reference-v1-stable/dataframe/dataframe.apply_map.md b/api-reference-v1-stable/dataframe/dataframe.apply_map.md deleted file mode 100644 index 3819821..0000000 --- a/api-reference-v1-stable/dataframe/dataframe.apply_map.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -description: Apply a function to a Dataframe values element-wise. ---- - -# DataFrame.apply\_map - -danfo.DataFrame.**apply\_map**(callable, options) \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L1566)] - -| Parameters | Type | Description | Default | -| ---------- | -------- | --------------------------------------------------------------------- | --------- | -| callable | Function | Function to apply to each column or row | | -| options | Object | **axis**: 0 or 1. If 0, compute the power column-wise, if 1, row-wise | {axis: 1} | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -### Apply a function to all values in a DataFrame - -{% hint style="info" %} -Note that the specified function passed to `apply` will be called with each element in the DataFrame. If you need to apply a function across an axis, then use the [apply](danfo.dataframe.apply.md) function. -{% endhint %} - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - short_name: ["NG", "GH", "EGY", "SA"], - long_name: ["Nigeria", "Ghana", "Eqypt", "South Africa"] -} -let df = new dfd.DataFrame(data) - -function lower(x) { - return `${x}`.toLowerCase() -} - -let df_new = df.apply_map(lower) -df_new.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ short_name │ long_name ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 0 │ ng │ nigeria ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 1 │ gh │ ghana ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 2 │ egy │ eqypt ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 3 │ sa │ south africa ║ -╚════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/dataframe.astype.md b/api-reference-v1-stable/dataframe/dataframe.astype.md deleted file mode 100644 index e6434dc..0000000 --- a/api-reference-v1-stable/dataframe/dataframe.astype.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -description: Cast column of a DataFrame to a specified dtype. ---- - -# DataFrame.astype - -danfo.DataFrame.**astype**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/cf5c7ae3a009458e61eedd18d9c9b5b6b10d5276/danfojs/src/core/frame.js#L125)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | -| options | Object |{
column: Array, label/column name of column to cast
dtype: dtype to cast to. One of [string, float32, int32, boolean]
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
}
| { inplace: false } | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -### **Cast a float dtype column to int** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "A": [-20.1, 30, 47.3, -20] , - "B": [34, -4, 5, 6], - "C": [20.1, -20.23, 30.3, 40.11], - "D": ["a", "b", "c", "c"] } - -let df = new dfd.DataFrame(data) -df.print() -df.ctypes.print() - -let df_new = df.astype({column: "A", dtype: "int32"}) -df_new.print() - -df.ctypes.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -//before casting -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C │ D ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ -20.1 │ 34 │ 20.1 │ a ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 30 │ -4 │ -20.23 │ b ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 47.3 │ 5 │ 30.3 │ c ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ -20 │ 6 │ 40.11 │ c ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ A │ float32 ║ -╟───┼──────────────────────╢ -║ B │ int32 ║ -╟───┼──────────────────────╢ -║ C │ float32 ║ -╟───┼──────────────────────╢ -║ D │ string ║ -╚═══╧══════════════════════╝ - - - //after casting - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C │ D ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ -20 │ 34 │ 20.1 │ a ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 30 │ -4 │ -20.23 │ b ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 47 │ 5 │ 30.3 │ c ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ -20 │ 6 │ 40.11 │ c ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ A │ int32 ║ -╟───┼──────────────────────╢ -║ B │ int32 ║ -╟───┼──────────────────────╢ -║ C │ float32 ║ -╟───┼──────────────────────╢ -║ D │ string ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### **Casting a string column of numbers to int** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "A": [-20.1, 30, 47.3, -20] , - "B": [34, -4, 5, 6], - "C": [20.1, -20.23, 30.3, 40.11], - "D": ["20", "13", "45", "90"] } - -let df = new dfd.DataFrame(data) -let df_new = df.astype({column: "D", dtype: "int32"}) -df_new.print() - -df_new.ctypes.print() - - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C │ D ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ -20.1 │ 34 │ 20.1 │ 20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 30 │ -4 │ -20.23 │ 13 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 47.3 │ 5 │ 30.3 │ 45 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ -20 │ 6 │ 40.11 │ 90 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ A │ float32 ║ -╟───┼──────────────────────╢ -║ B │ int32 ║ -╟───┼──────────────────────╢ -║ C │ float32 ║ -╟───┼──────────────────────╢ -║ D │ int32 ║ -╚═══╧══════════════════════╝ - -``` -{% endtab %} -{% endtabs %} - -**Note:** Casting a string column of alphabets/words to numeric form will return NaNs as values - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "A": [-20.1, 30, 47.3, -20] , - "B": [34, -4, 5, 6], - "C": [20.1, -20.23, 30.3, 40.11], - "D": ["a", "b", "c", "c"] } - -let df = new dfd.DataFrame(data) -let df_new = df.astype({column: "D", dtype: "int32"}) -df_new.print() - -df_new.ctypes.print() - - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C │ D ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ -20.1 │ 34 │ 20.1 │ NaN ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 30 │ -4 │ -20.23 │ NaN ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 47.3 │ 5 │ 30.3 │ NaN ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ -20 │ 6 │ 40.11 │ NaN ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ A │ float32 ║ -╟───┼──────────────────────╢ -║ B │ int32 ║ -╟───┼──────────────────────╢ -║ C │ float32 ║ -╟───┼──────────────────────╢ -║ D │ int32 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/dataframe.axes.md b/api-reference-v1-stable/dataframe/dataframe.axes.md deleted file mode 100644 index 399a0a4..0000000 --- a/api-reference-v1-stable/dataframe/dataframe.axes.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -description: >- - Return an Object containing the axes of the DataFrame. It has the row axis - labels and column axis labels as the only members. They are returned in that - order. ---- - -# DataFrame.axis - -danfo.DataFrame.**axis** \[[source](https://github.com/opensource9ja/danfojs/blob/eb5919d2cac34271fc3b725fa24aa3ad4eacde37/danfojs/src/core/generic.js#L290)] - -**Returns:** - - **** return **Object** - -## **Examples** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"A": [-20.1, 30, 47.3, -20], - "B": [34, -4, 5, 6], - "C": [20, -20, 30, -40]} - -let df = new dfd.DataFrame(data, {index: ["a", "b", "c", "d"]}) - -console.log(df.axis) - - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -{ index: [ 'a', 'b', 'c', 'd' ], columns: [ 'A', 'B', 'C' ] } -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/dataframe.drop.md b/api-reference-v1-stable/dataframe/dataframe.drop.md deleted file mode 100644 index 0b742aa..0000000 --- a/api-reference-v1-stable/dataframe/dataframe.drop.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -description: >- - Drop specified labels from rows or columns.Remove rows or columns by - specifying label names and corresponding axis. ---- - -# DataFrame.drop - -danfo.DataFrame.**drop**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/cf5c7ae3a009458e61eedd18d9c9b5b6b10d5276/danfojs/src/core/frame.js#L125)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | -| options | Object |{
columns: Array of column names to drop.
index: Array of index labels to drop.
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
}
| {**inplace:**false} | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -### Drop columns by specifying the names - -By setting **inplace** to _true_, the original DataFrame is modified and nothing is returned. To not modify the original DataFrame and return a new one, set **inplace** to false or leave it as default. - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "A": [-20, 30, 47.3, -20], - "B": [34, -4, 5, 6] , - "C": [20, 20, 30, 30], - "D": ["a", "b", "c", "c"] } - -let df = new dfd.DataFrame(data) -df.drop({ columns: ["C", "B"], inplace: true }); -df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╗ -║ │ A │ D ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ -20 │ a ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ 30 │ b ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ 47.3 │ c ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ -20 │ c ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Drop rows by specifying int labels/index - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "A": [-20, 30, 47.3, -20], - "B": [34, -4, 5, 6], - "C": [20, 20, 30, 30], - "D": ["a", "b", "c", "c"] -} - -let df = new dfd.DataFrame(data) -df.drop({ index: [0, 2], inplace: true }); -df.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C │ D ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 30 │ -4 │ 20 │ b ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ -20 │ 6 │ 30 │ c ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Drop rows by specifying string labels/index - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "A": [-20, 30, 47.3, -20], - "B": [34, -4, 5, 6] , - "C": [20, 20, 30, 30], - "D": ["a", "b", "c", "c"] } - -let df = new dfd.DataFrame(data, {index: ["a", "b", "c", "d"]}) -df.drop({ index: ["a", "c"], inplace: true }); -df.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C │ D ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ b │ 30 │ -4 │ 20 │ b ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ d │ -20 │ 6 │ 30 │ c ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/dataframe.dtypes.md b/api-reference-v1-stable/dataframe/dataframe.dtypes.md deleted file mode 100644 index 791d296..0000000 --- a/api-reference-v1-stable/dataframe/dataframe.dtypes.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -description: >- - Return the inferred column types in the DataFrame. This returns a Series with - the data type of each column. The result’s index is the original DataFrame’s - columns. ---- - -# DataFrame.ctypes - -danfo.DataFrame.**dtypes** \[[source](https://github.com/opensource9ja/danfojs/blob/eb5919d2cac34271fc3b725fa24aa3ad4eacde37/danfojs/src/core/frame.js#L1848)] - -**Returns:** - - **** return **Series** - -## **Examples** - -Returns auto-generated **** index of a **** DataFrame - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"A": [-20.1, 30, 47.3, -20], - "B": [34, -4, 5, 6], - "C": [20, -20, 30, -40]} - -let df = new dfd.DataFrame(data) - -df.ctypes.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ A │ float32 ║ -╟───┼──────────────────────╢ -║ B │ int32 ║ -╟───┼──────────────────────╢ -║ C │ int32 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -Columns with mixed types are represented as **string.** - -{% tabs %} -{% tab title="Node" %} -```javascript - -const dfd = require("danfojs-node") - -let data = {"A": [-20.1, 30, 47.3, -20], - "B": [34, -4, 5, 6], - "C": [20, -20, 30, -40], - "D": ["a", "b", 20, 2.5]} - -let df = new dfd.DataFrame(data) - -df.ctypes.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ A │ float32 ║ -╟───┼──────────────────────╢ -║ B │ int32 ║ -╟───┼──────────────────────╢ -║ C │ int32 ║ -╟───┼──────────────────────╢ -║ D │ string ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -**Note**: To cast a type, use the [astype](dataframe.astype.md) method. diff --git a/api-reference-v1-stable/dataframe/dataframe.index.md b/api-reference-v1-stable/dataframe/dataframe.index.md deleted file mode 100644 index a185e63..0000000 --- a/api-reference-v1-stable/dataframe/dataframe.index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -description: The index (row labels) of the DataFrame. ---- - -# DataFrame.index - -danfo.DataFrame.**index** \[[source](https://github.com/opensource9ja/danfojs/blob/3398c2f540c16ac95599a05b6f2db4eff8a258c9/danfojs/src/core/frame.js#L940)] - -## **Examples** - -Returns auto-generated **** index of a **** DataFrame - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"A": [-20.1, 30, 47.3, -20], - "B": [34, -4, 5, 6], - "C": [20, -20, 30, -40]} -let df = new dfd.DataFrame(data) - -console.log(df.index); -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -[0, 1, 2, 3] -``` -{% endtab %} -{% endtabs %} - - - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"A": [-20.1, 30, 47.3, -20], - "B": [34, -4, 5, 6], - "C": [20, -20, 30, -40]} -let df = new dfd.DataFrame(data, {index: ["r1", "r2", "r3", "r4"]) - -console.log(df.index); -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -[ 'r1', 'r2', 'r3', 'r4' ] -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/dataframe.ndim.md b/api-reference-v1-stable/dataframe/dataframe.ndim.md deleted file mode 100644 index c64dd09..0000000 --- a/api-reference-v1-stable/dataframe/dataframe.ndim.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -description: >- - Return an int representing the number of axes / array dimensions. Returns 1 if - Series. Otherwise return 2 for DataFrame. ---- - -# DataFrame.ndim - -danfo.DataFrame.**ndim** \[[source](https://github.com/opensource9ja/danfojs/blob/eb5919d2cac34271fc3b725fa24aa3ad4eacde37/danfojs/src/core/generic.js#L290)] - -**Returns:** - - **** return **Int** - -**Note:** To get the **shape** of the DataFrame use the .[shape](dataframe.shape.md) property. - -## **Examples** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"A": [-20.1, 30, 47.3, -20], - "B": [34, -4, 5, 6], - "C": [20, -20, 30, -40]} -let df = new dfd.DataFrame(data) - -console.log(df.ndim) - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -2 -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/dataframe.nunique-1.md b/api-reference-v1-stable/dataframe/dataframe.nunique-1.md deleted file mode 100644 index 8166904..0000000 --- a/api-reference-v1-stable/dataframe/dataframe.nunique-1.md +++ /dev/null @@ -1,98 +0,0 @@ -# DataFrame.nunique - -danfo.DataFrame.**nunique**(axis) \[[source](https://github.com/opensource9ja/danfojs/blob/f84d7f53f2b0639e464f9483fb5cea969ad913d6/danfojs/src/core/frame.js#L1975)] - -| Parameters | Type | Description | Default | -| ---------- | ---- | -------------------------------------- | ------- | -| axis | Int | 0 for row axis, and 1 for column axis | 1 | - -**Returns:** - - **** return **Series** - -## **Examples** - -### Return number of unique values along column axis (axis=1) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "A": [-20, 30, 47.3, -20] , - "B": [34, -4, 5, 6] , - "C": [20, 20, 30, 30], - "D": ["a", "b", "c", "c"] } - -let df = new dfd.DataFrame(data) -df.nunique().print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══╗ -║ 0 │ 3 ║ -╟───┼───╢ -║ 1 │ 4 ║ -╟───┼───╢ -║ 2 │ 2 ║ -╟───┼───╢ -║ 3 │ 3 ║ -╚═══╧═══╝ - -``` -{% endtab %} -{% endtabs %} - -### Return number of unique values in row axis (axis=0) - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "A": [-20, 30, 47.3, -20] , - "B": [34, -4, 5, 6] , - "C": [20, 20, 30, 30], - "D": ["a", "b", "c", "c"] } - -let df = new dfd.DataFrame(data) -df.nunique(axis=0).print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 4 ║ -╟───┼──────────────────────╢ -║ 1 │ 4 ║ -╟───┼──────────────────────╢ -║ 2 │ 4 ║ -╟───┼──────────────────────╢ -║ 3 │ 4 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -**Note:** To get the unique elements along an axis, use **** [DataFrame.unique.](dataframe.nunique-1.md) diff --git a/api-reference-v1-stable/dataframe/dataframe.print.md b/api-reference-v1-stable/dataframe/dataframe.print.md deleted file mode 100644 index d03232d..0000000 --- a/api-reference-v1-stable/dataframe/dataframe.print.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -description: >- - Pretty prints default (10) number of rows in a DataFrame or Series to the - console ---- - -# DataFrame.print - -danfo.DataFrame.**print()** \[[source](https://github.com/opensource9ja/danfojs/blob/eb5919d2cac34271fc3b725fa24aa3ad4eacde37/danfojs/src/core/generic.js#L290)] - -## **Examples** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "Abs": [20.2, 30, 47.3] , - "Count": [34, 4, 5] , - "country code": ["NG", "FR", "GH"] } - - -let df = new dfd.DataFrame(data) -df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Abs │ Count │ country code ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 20.2 │ 34 │ NG ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 30 │ 4 │ FR ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 47.3 │ 5 │ GH ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -Using JavaScript default **console.log** to display a DataFrame will return the Object instead unless you manually cast it to a String - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "Abs": [20.2, 30, 47.3] , - "Count": [34, 4, 5, 6] , - "country code": ["NG", "FR", "GH"] } - - -let df = new dfd.DataFrame(data) -console.log(df) -console.log(String(df)); -// console.log(df + ""); //same result as above -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -DataFrame { - '$isSeries': false, - '$config': Configs { - tableDisplayConfig: {}, - tableMaxRow: 10, - tableMaxColInConsole: 21, - dtypeTestLim: 7, - lowMemoryMode: false - }, - '$data': [ [ 20.2, 34, 'NG' ], [ 30, 5, 'FR' ], [ 47.3, 6, 'GH' ] ], - '$dataIncolumnFormat': [ [ 20.2, 30, 47.3 ], [ 34, 5, 6 ], [ 'NG', 'FR', 'GH' ] ], - '$index': [ 0, 1, 2 ], - '$dtypes': [ 'float32', 'int32', 'string' ], - '$columns': [ 'Abs', 'Count', 'country code' ] -} -╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Abs │ Count │ country code ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 20.2 │ 34 │ NG ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 30 │ 5 │ FR ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 47.3 │ 6 │ GH ║ -╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/dataframe.rename.md b/api-reference-v1-stable/dataframe/dataframe.rename.md deleted file mode 100644 index c33ce99..0000000 --- a/api-reference-v1-stable/dataframe/dataframe.rename.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -description: >- - Change axes labels. Object values must be unique (1-to-1). Labels not - contained in a dict / Series will be left as-is. Extra labels listed don’t - throw an error. ---- - -# DataFrame.rename - -danfo.DataFrame.**rename**(kwargs) \[[source](https://github.com/opensource9ja/danfojs/blob/cf5c7ae3a009458e61eedd18d9c9b5b6b10d5276/danfojs/src/core/frame.js#L125)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------- | -| options | Object |{
mapper: Object of labels and transformations to apply to that axis’ values.
axis: row=0, columns=1.
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
}
| {**axis**: 1, **inplace:**false} | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -### Rename columns - -By setting **inplace** to _true_, the original DataFrame is modified and nothing is returned. To not modify the original DataFrame and return a new one, set **inplace** to false or leave it as default. - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "A": [-20, 30, 47.3], - "B": [34, -4, 5], - "C": [20, 2, 30] } - - -let df = new dfd.DataFrame(data) -df.rename({ mapper: {"A": "new_name"},inplace: true }) -df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ new_name │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ -20 │ 34 │ 20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 30 │ -4 │ 20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 47.3 │ 5 │ 30 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Rename more the one column at time - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "A": [-20, 30, 47.3], - "B": [34, -4, 6], - "C": [20, 2, 30] } - - -let df = new dfd.DataFrame(data) -df = df.rename({ mapper: {"A": "new_name", "C": "new_c"}}) -df.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ new_name │ B │ new_c ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ -20 │ 34 │ 20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 30 │ -4 │ 20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 47.3 │ 5 │ 30 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Rename index by labels - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - "A": [-20, 30, 47.3], - "B": [34, -4, 6], - "C": [20, 2, 30] -} - - -let df = new dfd.DataFrame(data, { index: ["a", "b", "c"] }) -df = df.rename({ mapper: { "a": 0 }, axis: 0 }) -df.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ -20 │ 34 │ 20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ b │ 30 │ -4 │ 20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 47.3 │ 5 │ 30 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/dataframe.select_dtypes.md b/api-reference-v1-stable/dataframe/dataframe.select_dtypes.md deleted file mode 100644 index ba5044e..0000000 --- a/api-reference-v1-stable/dataframe/dataframe.select_dtypes.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -description: Return a subset of the DataFrame’s columns based on the column dtypes. ---- - -# DataFrame.select\_dtypes - -danfo.DataFrame.**select\_dtypes** \[[source](https://github.com/opensource9ja/danfojs/blob/db48bf9701e1c3205811ba2699b42ce56ef7e63b/danfojs/src/core/frame.js#L778)] - -| Parameters | Type | Description | Default | -| ---------- | ----- | -------------------------------- | ------- | -| include | Array | List of column dtypes to return | | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"A": [-20.1, 30, 47.3, -20], - "B": [34, -4, 5, 6], - "C": [20, -20, 30, -40], - "D": ["a", "b", 20, 2.5]} - -let df = new dfd.DataFrame(data) - -float_df = df.select_dtypes(['float32']) -float_df.print() - -mix_df = df.select_dtypes(include=['float32', "int32"]) -mix_df.print() - -str_df = df.select_dtypes(include=['string']) -str_df.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -//select float column(s) -╔═══╤══════════════════════╗ -║ │ A ║ -╟───┼──────────────────────╢ -║ 0 │ -20.1 ║ -╟───┼──────────────────────╢ -║ 1 │ 30 ║ -╟───┼──────────────────────╢ -║ 2 │ 47.3 ║ -╟───┼──────────────────────╢ -║ 3 │ -20 ║ -╚═══╧══════════════════════╝ - - - //select both float and int columns - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ -20.1 │ 34 │ 20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 30 │ -4 │ -20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 47.3 │ 5 │ 30 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ -20 │ 6 │ -40 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - -//return string type column -╔═══╤══════════════════════╗ -║ │ D ║ -╟───┼──────────────────────╢ -║ 0 │ a ║ -╟───┼──────────────────────╢ -║ 1 │ b ║ -╟───┼──────────────────────╢ -║ 2 │ 20 ║ -╟───┼──────────────────────╢ -║ 3 │ 2.5 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/dataframe.set_index.md b/api-reference-v1-stable/dataframe/dataframe.set_index.md deleted file mode 100644 index e82c213..0000000 --- a/api-reference-v1-stable/dataframe/dataframe.set_index.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -description: >- - Set the DataFrame index using existing columns or an array (of the equal - length). ---- - -# DataFrame.set_index - -danfo.DataFrame.**set_index**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/cf5c7ae3a009458e61eedd18d9c9b5b6b10d5276/danfojs/src/core/frame.js#L125)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | -| options | Object |{
index: An array of index values to set.
column: A column name to set the index to.
drop: Whether to drop the column whose index was set. Defaults to false.
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
}
| {**drop**: false, **inplace:**false} | - -## **Examples** - -### **Setting index to a column in the DataFrame** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "A": [-20, 30, 47.3], - "B": [34, 5, 6], - "C": [20, 3, 30] } - - -let df = new dfd.DataFrame(data, {index: ["a", "b", "c"]}) -df.print() - -df.set_index({column: "A", inplace: true}) -df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ a │ -20 │ 34 │ 20 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ b │ 30 │ 5 │ 3 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ c │ 47.3 │ 6 │ 30 ║ -╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - -╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ -20 │ -20 │ 34 │ 20 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 30 │ 30 │ 5 │ 3 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 47.3 │ 47.3 │ 6 │ 30 ║ -╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### **** - -### **Setting index to a column in the DataFrame and dropping the column** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "A": [-20, 30, 47.3], - "B": [34, 5, 6], - "C": [20, 3, 30] } - - -let df = new dfd.DataFrame(data, {index: ["a", "b", "c"]}) -df.print() - -df.set_index({column: "A", drop: true, inplace: true}) -df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ a │ -20 │ 34 │ 20 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ b │ 30 │ 5 │ 3 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ c │ 47.3 │ 6 │ 30 ║ -╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - -╔════════════╤═══════════════════╤═══════════════════╗ -║ │ B │ C ║ -╟────────────┼───────────────────┼───────────────────╢ -║ -20 │ 34 │ 20 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 30 │ 5 │ 3 ║ -╟────────────┼───────────────────┼───────────────────╢ -║ 47.3 │ 6 │ 30 ║ -╚════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### **Set index to an array of the same length** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "A": [-20, 30, 47.3], - "B": [34, -5, 6], - "C": [20, 3, 30] } - - -let df = new dfd.DataFrame(data) -df.print() - -let new_index = ["a", "b", "c"] -df.set_index({index: new_index, inplace: true}) -df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ -20 │ 34 │ 20 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 30 │ -5 │ 3 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 47.3 │ 6 │ 30 ║ -╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - -╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ a │ -20 │ 34 │ 20 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ b │ 30 │ -5 │ 3 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ c │ 47.3 │ 6 │ 30 ║ -╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -**Note:** To reset an index to the default values, use the [DataFrame.reset_index](dataframe.reset_index.md). diff --git a/api-reference-v1-stable/dataframe/dataframe.shape.md b/api-reference-v1-stable/dataframe/dataframe.shape.md deleted file mode 100644 index 746491d..0000000 --- a/api-reference-v1-stable/dataframe/dataframe.shape.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -description: Returns an Array representing the dimensionality of the DataFrame. ---- - -# DataFrame.shape - -danfo.DataFrame.**shape** \[[source](https://github.com/opensource9ja/danfojs/blob/eb5919d2cac34271fc3b725fa24aa3ad4eacde37/danfojs/src/core/generic.js#L290)] - -**Returns:** - - **** return **Int** - -## **Examples** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = {"A": [-20.1, 30, 47.3, -20], - "B": [34, -4, 5, 6], - "C": [20, -20, 30, -40]} -let df = new dfd.DataFrame(data, {index: ["a", "b", "c", "d"]}) - -console.log(df.shape) - - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -[4,3] -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/dataframe.sort_index.md b/api-reference-v1-stable/dataframe/dataframe.sort_index.md deleted file mode 100644 index 81d5b7f..0000000 --- a/api-reference-v1-stable/dataframe/dataframe.sort_index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -description: Sort DataFrame by index ---- - -# DataFrame.sort\_index - -DataFrame.**sort\_index**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/e25010c26d9c423412613d820015a48ad03d5c6d/danfojs-node/src/core/frame.js#L2094)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | -| options | Object |{
ascending: Sorting order.
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
}
| {**ascending**: true, **inplace:**false} | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -### **Sort DataFrame by a column in ascending order** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = [[0, 2, 4, "b"], - [360, 180, 360, "a"], - [2, 4, 6, "c"]] - -let df = new dfd.DataFrame(data, { "columns": ["col1", "col2", "col3", "col4"], - index: ["b", "a", "c"] }) -df.print() - -let df2 = df.sort_index({ ascending: false }) -df2.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ col1 │ col2 │ col3 │ col4 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ b │ 0 │ 2 │ 4 │ b ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ a │ 360 │ 180 │ 360 │ a ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ c │ 2 │ 4 │ 6 │ c ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - //after sorting in descending order - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ col1 │ col2 │ col3 │ col4 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ c │ 2 │ 4 │ 6 │ c ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ b │ 0 │ 2 │ 4 │ b ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ a │ 360 │ 180 │ 360 │ a ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -**** diff --git a/api-reference-v1-stable/dataframe/dataframe.sort_values.md b/api-reference-v1-stable/dataframe/dataframe.sort_values.md deleted file mode 100644 index 54345b1..0000000 --- a/api-reference-v1-stable/dataframe/dataframe.sort_values.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -description: Sort a Dataframe in ascending or descending order by a specified column name. ---- - -# DataFrame.sort\_values - -danfo.DataFrame.**sort\_values**(kwargs) \[[source](https://github.com/opensource9ja/danfojs/blob/cf5c7ae3a009458e61eedd18d9c9b5b6b10d5276/danfojs/src/core/frame.js#L125)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | -| options | Object |{
by: This key can be either a single column name or a single array of the same length as the calling DataFrame,
ascending: Order of sorting
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
}
| {**ascending**: true, **inplace:**false} | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -### **Sort DataFrame by a column in ascending order** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "A": [-20, 30, 47.3], - "B": [34, 5, 6], - "C": [20, 3, 30] } - - -let df = new dfd.DataFrame(data) -df.sort_values({by: "C", inplace: true}) -df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` - -╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 30 │ 5 │ 3 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ -20 │ 34 │ 20 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 47.3 │ 6 │ 30 ║ -╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### **Sort DataFrame by a column in descending order** - -{% tabs %} -{% tab title="Node" %} -```javascript - -const dfd = require("danfojs-node") - -let data = { "A": [-20, 30, 47.3], - "B": [34, 5, 6], - "C": [20, 3, 30] } - - -let df = new dfd.DataFrame(data) -df.sort_values({by: "B", inplace: true, ascending: false}) -df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ -20 │ 34 │ 20 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 47.3 │ 6 │ 30 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 30 │ 5 │ 3 ║ -╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/dataframe.tensor.md b/api-reference-v1-stable/dataframe/dataframe.tensor.md deleted file mode 100644 index 822886e..0000000 --- a/api-reference-v1-stable/dataframe/dataframe.tensor.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -description: >- - Return a Tensorflow tensor representation of the DataFrame. Only the values in - the DataFrame will be returned, the axes labels will be removed. ---- - -# DataFrame.tensor - -danfo.DataFrame.**tensor** \[[source](https://github.com/opensource9ja/danfojs/blob/eb5919d2cac34271fc3b725fa24aa3ad4eacde37/danfojs/src/core/generic.js#L290)] - -**Returns:** - - **** return **tf.tensor** - -> **Note:** [Tensorflow](https://js.tensorflow.org/api/latest/#tensor) tensors have single dtype, and will replace any string value with NaN. Use with care. - -## **Examples** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "A": [-20, 30, 47.3, -20] , - "B": [34, -4, 5, 6] , - "C": [20, 20, 30, 30]} - -let df = new dfd.DataFrame(data) -let tf_tensor = df.tensor - -console.log(tf_tensor.dtype); - -console.log(tf_tensor); - -tf_tensor.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -float32 -Tensor - [[-20 , 34, 20], - [30 , -4, 20], - [47.2999992, 5 , 30], - [-20 , 6 , 30]] -``` -{% endtab %} -{% endtabs %} - -String values in a Tensor are represented as NaN, so ensure to transform them before working with tensor representations. - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { "Abs": [20.2, 30, 47.3] , - "Count": [34, 5, 6] , - "country code": ["NG", "FR", "GH"] } - - -let df = new dfd.DataFrame(data) -let tf_tensor = df.tensor - -console.log(tf_tensor.dtype); - -console.log(tf_tensor); - -tf_tensor.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -float32 - -Tensor { - kept: false, - isDisposedInternal: false, - shape: [ 3, 3 ], - dtype: 'float32', - size: 9, - strides: [ 3 ], - dataId: {}, - id: 0, - rankType: '2' -} - -Tensor - [[20.2000008, 34, NaN], - [30 , 4 , NaN], - [47.2999992, 5 , NaN]] -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/dataframe/dataframe.to_csv.md b/api-reference-v1-stable/dataframe/dataframe.to_csv.md deleted file mode 100644 index 8e84e9a..0000000 --- a/api-reference-v1-stable/dataframe/dataframe.to_csv.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -description: Convert DataFrame data to a comma-separated values (csv) ---- - -# DataFrame.to\_csv - -DataFrame.**to\_csv**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/cf5c7ae3a009458e61eedd18d9c9b5b6b10d5276/danfojs/src/core/frame.js#L125)] - -| | | | | -| -------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| **Parameters** | Type | Description | Default | -| **options** | object, optional |Configuration object:
{
filePath: Local file path to write the CSV file to. If not specified, the CSV will be returned as a string. Only needed in Nodejs versionfileName: The name of the file to download as. Only needed in browser environment.download: Boolean indicating whether to automatically download the CSV file in the browser. Only needed in the browser environment.
header: Boolean indicating whether to include a header row in the CSV file.
sep: Character to be used as a separator in the CSV file.
}
|{
download: true,
sep: ","
}
Configuration object:
{
filePath: Local file path to write the CSV file to. If not specified, the CSV will be returned as a string. Only needed in Nodejs versionfileName: The name of the file to download as. Only needed in the browser environment. sheetName: Name to call the excel sheet.
}
|{
filePath: "./output.xlsx",
sheetName: "Sheet1"
}
Configuration object:
{
filePath: Local file path to write the CSV file to. If not specified, the CSV will be returned as a string. Only needed in Nodejs versionfileName: The name of the file to download as. Only needed in browser environment.format: The format of the JSON. Can be one of row or column.
}
|{format: "column"
}
{
df_list: List of DataFrames or Series to concatenate together.
axis: One of 0 or 1. The axis on which to perform concatenation. Specified axis must align in both Objects
}
| {**axis**: 1} | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -### **Concatenate two DataFrames along column axis (1)** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data = [['K0', 'k0', 'A0', 'B0'], ['k0', 'K1', 'A1', 'B1'], -['K1', 'K0', 'A2', 'B2'], ['K2', 'K2', 'A3', 'B3']] - -let data2 = [['K0', 'k0', 'C0', 'D0'], ['K1', 'K0', 'C1', 'D1'], -['K1', 'K0', 'C2', 'D2'], ['K2', 'K0', 'C3', 'D3']] - -let colum1 = ['Key1', 'Key2', 'A', 'B'] -let colum2 = ['Key1', 'Key2', 'A', 'D'] - -let df1 = new dfd.DataFrame(data, { columns: colum1 }) -let df2 = new dfd.DataFrame(data2, { columns: colum2 }) - - -let com_df = dfd.concat({ df_list: [df1, df2], axis: 1 }) -com_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Key1 │ Key2 │ A │ ... │ Key1_2 │ Key2_2 │ A_2 │ D ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ K0 │ k0 │ A0 │ ... │ K0 │ k0 │ C0 │ D0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ k0 │ K1 │ A1 │ ... │ K1 │ K0 │ C1 │ D1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ K1 │ K0 │ A2 │ ... │ K1 │ K0 │ C2 │ D2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ K2 │ K2 │ A3 │ ... │ K2 │ K0 │ C3 │ D3 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### **Concatenate two DataFrames along row axis (0)** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data = [['K0', 'k0', 'A0', 'B0'], ['k0', 'K1', 'A1', 'B1'], -['K1', 'K0', 'A2', 'B2'], ['K2', 'K2', 'A3', 'B3']] - -let data2 = [['K0', 'k0', 'C0', 'D0'], ['K1', 'K0', 'C1', 'D1'], -['K1', 'K0', 'C2', 'D2'], ['K2', 'K0', 'C3', 'D3']] - -let colum1 = ['Key1', 'Key2', 'A', 'B'] -let colum2 = ['Key1', 'Key2', 'A', 'D'] - -let df1 = new dfd.DataFrame(data, { columns: colum1 }) -let df2 = new dfd.DataFrame(data2, { columns: colum2 }) - - -let com_df = dfd.concat({ df_list: [df1, df2], axis: 0 }) -com_df.print(10) -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Key1 │ Key2 │ A │ B │ D ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ K0 │ k0 │ A0 │ B0 │ NaN ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ k0 │ K1 │ A1 │ B1 │ NaN ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ K1 │ K0 │ A2 │ B2 │ NaN ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ K2 │ K2 │ A3 │ B3 │ NaN ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ K0 │ k0 │ C0 │ NaN │ D0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 5 │ K1 │ K0 │ C1 │ NaN │ D1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 6 │ K1 │ K0 │ C2 │ NaN │ D2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 7 │ K2 │ K0 │ C3 │ NaN │ D3 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### **Concatenate two Series along row axis (0)** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data = [['K0', 'k0', 'A0', 'B0'], ['k0', 'K1', 'A1', 'B1'], -['K1', 'K0', 'A2', 'B2'], ['K2', 'K2', 'A3', 'B3']] - -let data2 = [['K0', 'k0', 'C0', 'D0'], ['K1', 'K0', 'C1', 'D1'], -['K1', 'K0', 'C2', 'D2'], ['K2', 'K0', 'C3', 'D3']] - -let colum1 = ['Key1', 'Key2', 'A', 'B'] -let colum2 = ['Key1', 'Key2', 'A', 'D'] - -let df1 = new dfd.DataFrame(data, { columns: colum1 }) -let df2 = new dfd.DataFrame(data2, { columns: colum2 }) - - -let com_df = dfd.concat({ df_list: [df1, df2], axis: 0 }) -com_df.print(10) -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Key1 │ Key2 │ A │ B │ D ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ K0 │ k0 │ A0 │ B0 │ NaN ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ k0 │ K1 │ A1 │ B1 │ NaN ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ K1 │ K0 │ A2 │ B2 │ NaN ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ K2 │ K2 │ A3 │ B3 │ NaN ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ K0 │ k0 │ C0 │ NaN │ D0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 5 │ K1 │ K0 │ C1 │ NaN │ D1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 6 │ K1 │ K0 │ C2 │ NaN │ D2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 7 │ K2 │ K0 │ C3 │ NaN │ D3 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -See also [danfo.concat ](danfo.concat.md)for joining objects based on axis. diff --git a/api-reference-v1-stable/general-functions/danfo.date_range.md b/api-reference-v1-stable/general-functions/danfo.date_range.md deleted file mode 100644 index 9c4a337..0000000 --- a/api-reference-v1-stable/general-functions/danfo.date_range.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -description: Return a fixed frequency Dates spread between start and end parameters. ---- - -# danfo.date\_range - -danfo.**date\_range**(kwargs) \[[source](https://github.com/opensource9ja/danfojs/blob/fe56860b0a303d218d60ba71dee6abf594401556/danfojs/src/core/frame.js#L254)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | -| **kwargs** | Object |{
start: str or datetime-like. Left bound for generating dates.
end: str or datetime-like. Right bound for generating dates.
period : int. Number of periods to generate.
freq: str or DateOffset, one of ["M","D","s","H","m","Y"].
}
| {**freq:** 'D'} | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = new dfd.date_range({"start":'1/1/2018',period:5, freq:'M'}) -console.log(data); -``` -{% endtab %} - -{% tab title="Browser" %} -```markup - - - - - - - - -{
columns: Array of column names to dummify. If not specified, all categorical columns are encoded.
prefixSeparator: String separator for created columns e.g "_",
prefix: String | Array of String, of column names
}
| {**prefixSeparator**: "\_"} | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -### **Convert Series to Dummy codes** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let datasf = ['pear', 'mango', "pawpaw", "mango", "bean"] -let sf1 = new dfd.Series(datasf) - -let dum_df = dfd.get_dummies(sf1, { prefix: "fruit" }) -dum_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` - -╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ fruit_pear │ fruit_mango │ fruit_pawpaw │ fruit_bean ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 1 │ 0 │ 0 │ 0 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 0 │ 1 │ 0 │ 0 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 0 │ 0 │ 1 │ 0 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 0 │ 1 │ 0 │ 0 ║ -╟────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ 0 │ 0 │ 0 │ 1 ║ -╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### **Convert all categorical columns in a DataFrame to Dummy codes** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { fruits: ['pear', 'mango', "pawpaw", "mango", "bean"], - Count: [20, 30, 89, 12, 30], - Country: ["NG", "NG", "GH", "RU", "RU"]} - -let df = new dfd.DataFrame(data) -df.print() - -let dum_df = dfd.get_dummies(df) -dum_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ fruits │ Count │ Country ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ pear │ 20 │ NG ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ mango │ 30 │ NG ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ pawpaw │ 89 │ GH ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ mango │ 12 │ RU ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ bean │ 30 │ RU ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - //after dummification - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Count │ fruits_pear │ fruits_mango │ ... │ fruits_bean │ Country_NG │ Country_GH │ Country_RU ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 20 │ 1 │ 0 │ ... │ 0 │ 1 │ 0 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 30 │ 0 │ 1 │ ... │ 0 │ 1 │ 0 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 89 │ 0 │ 0 │ ... │ 0 │ 0 │ 1 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 12 │ 0 │ 1 │ ... │ 0 │ 0 │ 0 │ 1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ 30 │ 0 │ 0 │ ... │ 1 │ 0 │ 0 │ 1 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### **Convert a specific column in a DataFrame to Dummy codes** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { fruits: ['pear', 'mango', "pawpaw", "mango", "bean"], - Count: [20, 30, 89, 12, 30], - Country: ["NG", "NG", "GH", "RU", "RU"]} - -let df = new dfd.DataFrame(data) -df.print() - -let dum_df = dfd.get_dummies(df, { columns: ['fruits']}) -dum_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ fruits │ Count │ Country ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ pear │ 20 │ NG ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ mango │ 30 │ NG ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ pawpaw │ 89 │ GH ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ mango │ 12 │ RU ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ bean │ 30 │ RU ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - //after dummification - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Count │ Country │ fruits_pear │ fruits_mango │ fruits_pawpaw │ fruits_bean ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 20 │ NG │ 1 │ 0 │ 0 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 30 │ NG │ 0 │ 1 │ 0 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 89 │ GH │ 0 │ 0 │ 1 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 12 │ RU │ 0 │ 1 │ 0 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ 30 │ RU │ 0 │ 0 │ 0 │ 1 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -{% hint style="info" %} -See also [LabelEncoder](danfo.labelencoder.md) and [OneHotEncoder](danfo.onehotencoder.md) -{% endhint %} diff --git a/api-reference-v1-stable/general-functions/danfo.labelencoder.md b/api-reference-v1-stable/general-functions/danfo.labelencoder.md deleted file mode 100644 index b0745a8..0000000 --- a/api-reference-v1-stable/general-functions/danfo.labelencoder.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -description: Encode target labels with value between 0 and n_classes-1. ---- - -# danfo.LabelEncoder - -class danfo.**LabelEncoder** \[[source](https://github.com/opensource9ja/danfojs/blob/fe56860b0a303d218d60ba71dee6abf594401556/danfojs/src/core/frame.js#L254)] - -danfo.js provides the LabelEncoder class for encoding Series and Arrays to integer between 0 and n\_classes -1. This is mostly used as a preprocessing step before most machine learning tasks. - -The API is similar to sklearn's [LabelEncoder](https://scikit-learn.org/stable/modules/generated/sklearn.preprocessing.LabelEncoder.html?highlight=labelencoder#sklearn.preprocessing.LabelEncoder), and provides a fit and transform method. - -## **Examples** - -### **Label Encode values in a Series** - -{% tabs %} -{% tab title="Node" %} -```javascript -let data = ["dog","cat","man","dog","cat","man","man","cat"] -let series = new dfd.Series(data) - -let encode = new dfd.LabelEncoder() - -encode.fit(series) -console.log(encode); - -let sf_enc = encode.transform(series.values) -sf_enc.print() - -let new_sf = encode.transform(["dog","man"]) -new_sf.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -LabelEncoder { label: [ 'dog', 'cat', 'man' ] } -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 0 ║ -╟───┼──────────────────────╢ -║ 1 │ 1 ║ -╟───┼──────────────────────╢ -║ 2 │ 2 ║ -╟───┼──────────────────────╢ -║ 3 │ 0 ║ -╟───┼──────────────────────╢ -║ 4 │ 1 ║ -╟───┼──────────────────────╢ -║ 5 │ 2 ║ -╟───┼──────────────────────╢ -║ 6 │ 2 ║ -╟───┼──────────────────────╢ -║ 7 │ 1 ║ -╚═══╧══════════════════════╝ - -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 0 ║ -╟───┼──────────────────────╢ -║ 1 │ 2 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -{% hint style="info" %} -**Labels not found in the original data used for fitting are represented with -1** -{% endhint %} - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { fruits: ['pear', 'mango', "pawpaw", "mango", "bean"] , - Count: [20, 30, 89, 12, 30], - Country: ["NG", "NG", "GH", "RU", "RU"]} - - -let df = new dfd.DataFrame(data) -let encode = new dfd.LabelEncoder() - -encode.fit(df['fruits']) -console.log(encode); - -let sf_enc = encode.transform(df['fruits'].values) -sf_enc.print() - -let new_sf = encode.transform(["mango","man"]) -new_sf.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -LabelEncoder { label: [ 'pear', 'mango', 'pawpaw', 'bean' ] } -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 0 ║ -╟───┼──────────────────────╢ -║ 1 │ 1 ║ -╟───┼──────────────────────╢ -║ 2 │ 2 ║ -╟───┼──────────────────────╢ -║ 3 │ 1 ║ -╟───┼──────────────────────╢ -║ 4 │ 3 ║ -╚═══╧══════════════════════╝ - -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 1 ║ -╟───┼──────────────────────╢ -║ 1 │ -1 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -See also [OneHotEncoder](danfo.onehotencoder.md) and[ danfo.get\_dummies](danfo.get\_dummies.md) diff --git a/api-reference-v1-stable/general-functions/danfo.merge.md b/api-reference-v1-stable/general-functions/danfo.merge.md deleted file mode 100644 index 0c4b760..0000000 --- a/api-reference-v1-stable/general-functions/danfo.merge.md +++ /dev/null @@ -1,453 +0,0 @@ ---- -description: >- - Merge DataFrame or named Series objects with a database-style join.The join is - done on columns or indexes. ---- - -# danfo.merge - -danfo.**merge**(kwargs) \[[source](https://github.com/opensource9ja/danfojs/blob/fe56860b0a303d218d60ba71dee6abf594401556/danfojs/src/core/frame.js#L254)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | -| **kwargs** | Object |{
left: A DataFrame or named Series object.
right: Another DataFrame or named Series object.
on: Column names to join on. Must be found in both the left and right DataFrame and/or Series objects.
how: One of 'left','right','outer', 'inner'. Defaults to 'inner'
}
| {**how**: inner} | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -**danfo.js** merge function is similar to Pandas merge and performs in-memory join operations idiomatically very similar to relational databases like SQL. - -danfo.js provides a single function, [`merge()`](danfo.merge.md), as the entry point for all standard database join operations between `DataFrame` or named `Series` objects. - -For a more intuitive understanding, this [guide](https://pandas.pydata.org/pandas-docs/stable/user\_guide/merging.html#brief-primer-on-merge-methods-relational-algebra) on the [Pandas](https://pandas.pydata.org/pandas-docs/stable) doc is worth reading. - -### **Merging by a single key found in both axis** - -By default, danfo performs _**inner**_ join. An inner join requires each row in the two joined DataFrames to have matching column values. This is similar to the **intersection** of two sets. It returns a DataFrame with only those rows that have common characteristics. - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data = [['K0', 'k0', 'A0', 'B0'], ['k0', 'K1', 'A1', 'B1'], - ['K1', 'K0', 'A2', 'B2'], ['K2', 'K2', 'A3', 'B3']] - -let data2 = [['K0', 'k0', 'C0', 'D0'], ['K1', 'K0', 'C1', 'D1'], - ['K1', 'K0', 'C2', 'D2'], ['K2', 'K0', 'C3', 'D3']] - -let colum1 = ['Key1', 'Key2', 'A', 'B'] -let colum2 = ['Key1', 'Key2', 'A', 'D'] - -let df1 = new dfd.DataFrame(data, { columns: colum1 }) -let df2 = new dfd.DataFrame(data2, { columns: colum2 }) -df1.print() -df2.print() - -let merge_df = dfd.merge({ "left": df1, "right": df2, "on": ["Key1"]}) -merge_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` - - //first DataFrame -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Key1 │ Key2 │ A │ B ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ K0 │ k0 │ A0 │ B0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ k0 │ K1 │ A1 │ B1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ K1 │ K0 │ A2 │ B2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ K2 │ K2 │ A3 │ B3 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - //Second DataFrame - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Key1 │ Key2 │ A │ D ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ K0 │ k0 │ C0 │ D0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ K1 │ K0 │ C1 │ D1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ K1 │ K0 │ C2 │ D2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ K2 │ K0 │ C3 │ D3 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - //After inner join on column 'Key1' - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Key1 │ Key2 │ A │ B │ Key2_1 │ A_1 │ D ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ K0 │ k0 │ A0 │ B0 │ k0 │ C0 │ D0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ K1 │ K0 │ A2 │ B2 │ K0 │ C1 │ D1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ K1 │ K0 │ A2 │ B2 │ K0 │ C2 │ D2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ K2 │ K2 │ A3 │ B3 │ K0 │ C3 │ D3 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - -``` -{% endtab %} -{% endtabs %} - -### **Inner Join/Merge by multiple keys found in both axis** - -Merging by two keys takes into consideration the keys appearing in both`left` and `right DataFrame.` - -{% tabs %} -{% tab title="Node" %} -```javascript - -const dfd = require("danfojs-node") - - -let data = [['K0', 'k0', 'A0', 'B0'], ['k0', 'K1', 'A1', 'B1'], - ['K1', 'K0', 'A2', 'B2'], ['K2', 'K2', 'A3', 'B3']] - -let data2 = [['K0', 'k0', 'C0', 'D0'], ['K1', 'K0', 'C1', 'D1'], - ['K1', 'K0', 'C2', 'D2'], ['K2', 'K0', 'C3', 'D3']] - -let colum1 = ['Key1', 'Key2', 'A', 'B'] -let colum2 = ['Key1', 'Key2', 'A', 'D'] - -let df1 = new dfd.DataFrame(data, { columns: colum1 }) -let df2 = new dfd.DataFrame(data2, { columns: colum2 }) -df1.print() -df2.print() - -let merge_df = dfd.merge({ left: df1, right: df2, - on: ["Key1", 'Key2'], how: "inner"}) -merge_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -//first DataFrame -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Key1 │ Key2 │ A │ B ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ K0 │ k0 │ A0 │ B0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ k0 │ K1 │ A1 │ B1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ K1 │ K0 │ A2 │ B2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ K2 │ K2 │ A3 │ B3 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - - -//second DataFrame - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Key1 │ Key2 │ A │ D ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ K0 │ k0 │ C0 │ D0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ K1 │ K0 │ C1 │ D1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ K1 │ K0 │ C2 │ D2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ K2 │ K0 │ C3 │ D3 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - //After inner join on two keys - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Key1 │ Key2 │ A │ B │ A_1 │ D ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ K0 │ k0 │ A0 │ B0 │ C0 │ D0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ K1 │ K0 │ A2 │ B2 │ C1 │ D1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ K1 │ K0 │ A2 │ B2 │ C2 │ D2 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - -``` -{% endtab %} -{% endtabs %} - -The how parameter takes other types of joins like left, right and outer join and these are similar to their SQL equivalent - -### Outer join/merge on DataFrame - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data = [['K0', 'k0', 'A0', 'B0'], ['k0', 'K1', 'A1', 'B1'], - ['K1', 'K0', 'A2', 'B2'], ['K2', 'K2', 'A3', 'B3']] - -let data2 = [['K0', 'k0', 'C0', 'D0'], ['K1', 'K0', 'C1', 'D1'], - ['K1', 'K0', 'C2', 'D2'], ['K2', 'K0', 'C3', 'D3']] - -let colum1 = ['Key1', 'Key2', 'A', 'B'] -let colum2 = ['Key1', 'Key2', 'A', 'D'] - -let df1 = new dfd.DataFrame(data, { columns: colum1 }) -let df2 = new dfd.DataFrame(data2, { columns: colum2 }) -df1.print() -df2.print() - -let merge_df = dfd.merge({ left: df1, right: df2, - on: ["Key1"], how: "outer"}) -merge_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -//First DataFrame -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Key1 │ Key2 │ A │ B ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ K0 │ k0 │ A0 │ B0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ k0 │ K1 │ A1 │ B1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ K1 │ K0 │ A2 │ B2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ K2 │ K2 │ A3 │ B3 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - //Second DataFrame - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Key1 │ Key2 │ A │ D ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ K0 │ k0 │ C0 │ D0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ K1 │ K0 │ C1 │ D1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ K1 │ K0 │ C2 │ D2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ K2 │ K0 │ C3 │ D3 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - -//After outer join - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Key1 │ Key2 │ A │ B │ Key2_1 │ A_1 │ D ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ K0 │ k0 │ A0 │ B0 │ k0 │ C0 │ D0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ k0 │ K1 │ A1 │ B1 │ NaN │ NaN │ NaN ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ K1 │ K0 │ A2 │ B2 │ K0 │ C1 │ D1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ K1 │ K0 │ A2 │ B2 │ K0 │ C2 │ D2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ K2 │ K2 │ A3 │ B3 │ K0 │ C3 │ D3 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Left join/merge on DataFrame - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data = [['K0', 'k0', 'A0', 'B0'], ['k0', 'K1', 'A1', 'B1'], - ['K1', 'K0', 'A2', 'B2'], ['K2', 'K2', 'A3', 'B3']] - -let data2 = [['K0', 'k0', 'C0', 'D0'], ['K1', 'K0', 'C1', 'D1'], - ['K1', 'K0', 'C2', 'D2'], ['K2', 'K0', 'C3', 'D3']] - -let colum1 = ['Key1', 'Key2', 'A', 'B'] -let colum2 = ['Key1', 'Key2', 'A', 'D'] - -let df1 = new dfd.DataFrame(data, { columns: colum1 }) -let df2 = new dfd.DataFrame(data2, { columns: colum2 }) -df1.print() -df2.print() - -let merge_df = dfd.merge({ left: df1, right: df2, - on: ["Key1", "Key2"], how: "left"}) -merge_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -//first DataFrame -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Key1 │ Key2 │ A │ B ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ K0 │ k0 │ A0 │ B0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ k0 │ K1 │ A1 │ B1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ K1 │ K0 │ A2 │ B2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ K2 │ K2 │ A3 │ B3 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - - -//second DataFrame - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Key1 │ Key2 │ A │ D ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ K0 │ k0 │ C0 │ D0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ K1 │ K0 │ C1 │ D1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ K1 │ K0 │ C2 │ D2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ K2 │ K0 │ C3 │ D3 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - After left join -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Key1 │ Key2 │ A │ B │ A_1 │ D ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ K0 │ k0 │ A0 │ B0 │ C0 │ D0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ k0 │ K1 │ A1 │ B1 │ NaN │ NaN ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ K1 │ K0 │ A2 │ B2 │ C1 │ D1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ K1 │ K0 │ A2 │ B2 │ C2 │ D2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ K2 │ K2 │ A3 │ B3 │ NaN │ NaN ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Right join/merge on DataFrame - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data = [['K0', 'k0', 'A0', 'B0'], ['k0', 'K1', 'A1', 'B1'], - ['K1', 'K0', 'A2', 'B2'], ['K2', 'K2', 'A3', 'B3']] - -let data2 = [['K0', 'k0', 'C0', 'D0'], ['K1', 'K0', 'C1', 'D1'], - ['K1', 'K0', 'C2', 'D2'], ['K2', 'K0', 'C3', 'D3']] - -let colum1 = ['Key1', 'Key2', 'A', 'B'] -let colum2 = ['Key1', 'Key2', 'A', 'D'] - -let df1 = new dfd.DataFrame(data, { columns: colum1 }) -let df2 = new dfd.DataFrame(data2, { columns: colum2 }) -df1.print() -df2.print() - -let merge_df = dfd.merge({ left: df1, right: df2, - on: ["Key1", "Key2"], how: "right"}) -merge_df.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -//first DataFrame -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Key1 │ Key2 │ A │ B ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ K0 │ k0 │ A0 │ B0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ k0 │ K1 │ A1 │ B1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ K1 │ K0 │ A2 │ B2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ K2 │ K2 │ A3 │ B3 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - //second DataFrame - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Key1 │ Key2 │ A │ D ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ K0 │ k0 │ C0 │ D0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ K1 │ K0 │ C1 │ D1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ K1 │ K0 │ C2 │ D2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ K2 │ K0 │ C3 │ D3 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - - -//after right join - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ Key1 │ Key2 │ A │ B │ A_1 │ D ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ K0 │ k0 │ A0 │ B0 │ C0 │ D0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ K1 │ K0 │ A2 │ B2 │ C1 │ D1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ K1 │ K0 │ A2 │ B2 │ C2 │ D2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ K2 │ K0 │ NaN │ NaN │ C3 │ D3 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -{% hint style="info" %} -See also [danfo.concat ](danfo.concat.md)for joining objects based on axis. -{% endhint %} diff --git a/api-reference-v1-stable/general-functions/danfo.minmaxscaler.md b/api-reference-v1-stable/general-functions/danfo.minmaxscaler.md deleted file mode 100644 index d58af8b..0000000 --- a/api-reference-v1-stable/general-functions/danfo.minmaxscaler.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -description: Transform features by scaling each feature to a range of max and min values. ---- - -# danfo.MinMaxScaler - -class danfo.**MinMaxScaler** \[[source](https://github.com/opensource9ja/danfojs/blob/fe56860b0a303d218d60ba71dee6abf594401556/danfojs/src/core/frame.js#L254)] - -danfo.js provides the MinMaxScaler class for standardization of DataFrame and Series. This estimator scales and translates each feature individually such that it is in the given range on the training set, e.g. between zero and one. - -This transformation is often used as an alternative to zero mean, unit variance scaling like [Standardscaler](danfo.standardscaler.md). - -The API is similar to sklearn's [MinMaxScaler](https://scikit-learn.org/stable/modules/generated/sklearn.preprocessing.MinMaxScaler.html?highlight=minmaxscaler#sklearn.preprocessing.MinMaxScaler), and provides a fit and transform method. - -## **Examples** - -### Standardize DataFrame Object using MinMaxScaler - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let scaler = new dfd.MinMaxScaler() - -let data = [[100,1000,2000, 3000] , - [20, 30, 20, 10], - [1, 1, 1, 0]] - -let df = new dfd.DataFrame(data) -df.print() - -scaler.fit(df) - -let df_enc = scaler.transform(df) -df_enc.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ 0 │ 1 │ 2 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 100 │ 1000 │ 2000 │ 3000 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 20 │ 30 │ 20 │ 10 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 1 │ 1 │ 1 │ 0 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - Shape: (3,4) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ 0 │ 1 │ 2 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 1 │ 1 │ 1 │ 1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 0.19191919267... │ 0.02902902849... │ 0.00950475223... │ 0.00333333341... ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 0 │ 0 │ 0 │ 0 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Standardize Series Object Using MinMaxScaler - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") -let scaler = new dfd.MinMaxScaler() - -let data = [[100,1000,2000, 3000] , - [20, 30, 20, 10], - [1, 1, 1, 0]] - -let df = new dfd.DataFrame(data) -let sf = df.iloc({columns: ["0"]}) - -scaler.fit(sf) - -let df_enc = scaler.transform(sf) -df_enc.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` - - Shape: (3,1) - -╔═══╤═══════════════════╗ -║ │ 0 ║ -╟───┼───────────────────╢ -║ 0 │ 1 ║ -╟───┼───────────────────╢ -║ 1 │ 0.19191919267... ║ -╟───┼───────────────────╢ -║ 2 │ 0 ║ -╚═══╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -See also [MinMaxScaler](danfo.minmaxscaler.md) diff --git a/api-reference-v1-stable/general-functions/danfo.onehotencoder.md b/api-reference-v1-stable/general-functions/danfo.onehotencoder.md deleted file mode 100644 index 81c913d..0000000 --- a/api-reference-v1-stable/general-functions/danfo.onehotencoder.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -description: Encode categorical features as a one-hot numeric array. ---- - -# danfo.OneHotEncoder - -class danfo.**OneHotEncoder** \[[source](https://github.com/opensource9ja/danfojs/blob/e25010c26d9c423412613d820015a48ad03d5c6d/danfojs-node/src/preprocessing/encodings.js#L6)] - -danfo.js provides the OneHotEncoder class for encoding values in Series and Arrays to one-hot numeric arrays. This is mostly used as a preprocessing step before most machine learning tasks. - -The API is similar to scikit-learn's [OneHotEncoder](https://scikit-learn.org/stable/modules/generated/sklearn.preprocessing.OneHotEncoder.html?highlight=onehotencoder#sklearn.preprocessing.OneHotEncoder), and provides a fit and transform method. - -## **Examples** - -### **Convert Series to Dummy codes** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { fruits: ['pear', 'mango', "pawpaw", "mango", "bean"], - Count: [20, 30, 89, 12, 30], - Country: ["NG", "NG", "GH", "RU", "RU"]} - - -let df = new dfd.DataFrame(data) -let encode = new dfd.OneHotEncoder() - -encode.fit(df['fruits']) -console.log(encode); - -let sf_enc = encode.transform(df['fruits'].values) -sf_enc.print() - -let new_sf = encode.transform(["mango","bean"]) -new_sf.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ pear │ mango │ pawpaw │ bean ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 1 │ 0 │ 0 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 0 │ 1 │ 0 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 0 │ 0 │ 1 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 0 │ 1 │ 0 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ 0 │ 0 │ 0 │ 1 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - Shape: (2,4) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ pear │ mango │ pawpaw │ bean ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 0 │ 1 │ 0 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 0 │ 0 │ 0 │ 1 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - -``` -{% endtab %} -{% endtabs %} - -{% hint style="info" %} -**Labels not found in the original data used for fitting are represented with 0s all through** -{% endhint %} - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { fruits: ['pear', 'mango', "pawpaw", "mango", "bean"] , - Count: [20, 30, 89, 12, 30], - Country: ["NG", "NG", "GH", "RU", "RU"]} - - -let df = new dfd.DataFrame(data) -let encode = new dfd.OneHotEncoder() - -encode.fit(df['fruits']) -console.log(encode); - -let sf_enc = encode.transform(df['fruits'].values) -sf_enc.print() - -let new_sf = encode.transform(["mango","woman", "cup"]) -new_sf.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ pear │ mango │ pawpaw │ bean ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 1 │ 0 │ 0 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 0 │ 1 │ 0 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 0 │ 0 │ 1 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ 0 │ 1 │ 0 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ 0 │ 0 │ 0 │ 1 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - Shape: (3,4) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ pear │ mango │ pawpaw │ bean ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 0 │ 1 │ 0 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 0 │ 0 │ 0 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 0 │ 0 │ 0 │ 0 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - -``` -{% endtab %} -{% endtabs %} - -See also [LabelEncoder](danfo.labelencoder.md) and[ danfo.get\_dummies](danfo.get\_dummies.md) diff --git a/api-reference-v1-stable/general-functions/danfo.standardscaler.md b/api-reference-v1-stable/general-functions/danfo.standardscaler.md deleted file mode 100644 index 89ce861..0000000 --- a/api-reference-v1-stable/general-functions/danfo.standardscaler.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -description: Standardize features by removing the mean and scaling to unit variance. ---- - -# danfo.StandardScaler - -class danfo.**StandScaler** \[[source](https://github.com/opensource9ja/danfojs/blob/fe56860b0a303d218d60ba71dee6abf594401556/danfojs/src/core/frame.js#L254)] - -danfo.js provides the StandardScaler class for the standardization of DataFrame and Series. The standard score of a sample `x` is calculated as: - -> z = (x - u) / s - -where `u` is the mean of the training samples or zero if `with_mean=False`, and `s` is the standard deviation of the training samples or one if `with_std=False`. - -The API is similar to sklearn's [StandardScaler](https://scikit-learn.org/stable/modules/generated/sklearn.preprocessing.StandardScaler.html?highlight=standardscaler#sklearn.preprocessing.StandardScaler), and provides a fit and transform method. - -## **Examples** - -### Standardize Series Object - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let scaler = new dfd.StandardScaler() - -let sf = new dfd.Series([100,1000,2000, 3000]) -sf.print() - -scaler.fit(sf) - -let sf_enc = scaler.transform(sf) -sf_enc.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 100 ║ -╟───┼──────────────────────╢ -║ 1 │ 1000 ║ -╟───┼──────────────────────╢ -║ 2 │ 2000 ║ -╟───┼──────────────────────╢ -║ 3 │ 3000 ║ -╚═══╧══════════════════════╝ - -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ -1.1375757455825806 ║ -╟───┼──────────────────────╢ -║ 1 │ -0.4191068708896637 ║ -╟───┼──────────────────────╢ -║ 2 │ 0.37919193506240845 ║ -╟───┼──────────────────────╢ -║ 3 │ 1.1774907112121582 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Standardize DataFrame Object - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") -let scaler = new dfd.StandardScaler() - -let data = [[100,1000,2000, 3000] , - [20, 30, 89, 12], - [1, 1, 1, 0]] - -let df = new dfd.DataFrame(data) -df.print() - -scaler.fit(df) - -let df_enc = scaler.transform(df) -df_enc.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ 0 │ 1 │ 2 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ 100 │ 1000 │ 2000 │ 3000 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 20 │ 30 │ 20 │ 10 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 1 │ 1 │ 1 │ 0 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - Shape: (3,4) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ 0 │ 1 │ 2 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ -0.4185734987... │ 0.48862975835... │ 1.49663341045... │ 2.50463700294... ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ -0.4992137849... │ -0.4891337454319 │ -0.4992137849... │ -0.5092938542... ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ -0.5183658599... │ -0.5183658599... │ -0.5183658599... │ -0.5193738341... ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -See also [MinMaxScaler](danfo.minmaxscaler.md) diff --git a/api-reference-v1-stable/general-functions/danfo.to_datetime.md b/api-reference-v1-stable/general-functions/danfo.to_datetime.md deleted file mode 100644 index 7012100..0000000 --- a/api-reference-v1-stable/general-functions/danfo.to_datetime.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -description: Converts an array of Date time string to Date object. ---- - -# danfo.toDateTime - -danfo.**toDateTime**(data) \[[source](https://github.com/opensource9ja/danfojs/blob/fe56860b0a303d218d60ba71dee6abf594401556/danfojs/src/core/frame.js#L254)] - -| Parameters | Type | Description | Default | -| ---------- | ------------- | ----------------------------------------------------------------------------------------------------------------- | ------- | -| **data** | Array, Series |data: Array | Series with Date strings to convert to Date time.
| | - -**Returns:** - - **** return **DataFrame** - -## **Examples** - -Converts a **Series** of Date strings to Date time and get time properties - -{% tabs %} -{% tab title="Node" %} -```javascript -let data = new dfd.date_range({"start":'1/1/2018',period:12, freq:'M'}) -let sf = new dfd.Series(data) -sf.print() - -let dt = dfd.toDateTime(data) - -dt.month().print() -dt.month_name().print() -dt.weekdays().print() -dt.day().print() -dt.seconds().print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` - 0 -0 1/1/2018, 12:00:00 AM -1 2/1/2018, 12:00:00 AM -2 3/1/2018, 12:00:00 AM -3 4/1/2018, 12:00:00 AM -4 5/1/2018, 12:00:00 AM -5 6/1/2018, 12:00:00 AM -6 7/1/2018, 12:00:00 AM -7 8/1/2018, 12:00:00 AM -8 9/1/2018, 12:00:00 AM -9 10/1/2018, 12:00:00 AM -10 11/1/2018, 12:00:00 AM -11 12/1/2018, 12:00:00 AM - -//Int representation for month - 0 -0 0 -1 1 -2 2 -3 3 -4 4 -5 5 -6 6 -7 7 -8 8 -9 9 -10 10 -11 11 - -//string representation for month -0 -0 Jan -1 Feb -2 Mar -3 Apr -4 May -5 Jun -6 Jul -7 Aug -8 Sep -9 Oct -10 Nov -11 Dec - -//string representation for day of the week -0 -0 Mon -1 Thur -2 Thur -3 Sun -4 Tue -5 Fri -6 Sun -7 Wed -8 Sat -9 Mon -10 Thur -11 Sat - -0 -0 1 -1 4 -2 4 -3 0 -4 2 -5 5 -6 0 -7 3 -8 6 -9 1 -10 4 -11 6 - -//Hour of the day -0 -0 0 -1 0 -2 0 -3 0 -4 0 -5 0 -6 0 -7 0 -8 0 -9 0 -10 0 -11 0 - -``` -{% endtab %} -{% endtabs %} - -{% hint style="info" %} -Date time properties of Series or datetime-like columns in DataFrame can be accessed via accessors in the **dt** name-space. See [Accessors](https://app.gitbook.com/@jsdata/s/danfojs/\~/drafts/-MEMaWwva1cjt8CxnG-b/api-reference/series#accessors) -{% endhint %} diff --git a/api-reference-v1-stable/groupby.md b/api-reference-v1-stable/groupby.md deleted file mode 100644 index 1db2e52..0000000 --- a/api-reference-v1-stable/groupby.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -description: >- - GroupBy objects are returned by groupby calls: danfo.DataFrame.groupby(), - danfo.Series.groupby() ---- - -# Groupby - -### Indexing, iteration - -| [`GroupBy.__iter__`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.__iter__.html#pandas.core.groupby.GroupBy.__iter__)\(\) | Groupby iterator. | -| :--- | :--- | -| [`GroupBy.groups`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.groups.html#pandas.core.groupby.GroupBy.groups) | Dict {group name -> group labels}. | -| [`GroupBy.indices`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.indices.html#pandas.core.groupby.GroupBy.indices) | Dict {group name -> group indices}. | -| [`GroupBy.get_group`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.get_group.html#pandas.core.groupby.GroupBy.get_group)\(name\[, obj\]\) | Construct DataFrame from group with provided name. | - -| [`Grouper`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.Grouper.html#pandas.Grouper)\(\*args, \*\*kwargs\) | A Grouper allows the user to specify a groupby instruction for an object. | -| :--- | :--- | - - -### Function application - -| [`GroupBy.apply`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.apply.html#pandas.core.groupby.GroupBy.apply)\(func, \*args, \*\*kwargs\) | Apply function func group-wise and combine the results together. | -| :--- | :--- | -| [`GroupBy.agg`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.agg.html#pandas.core.groupby.GroupBy.agg)\(func, \*args, \*\*kwargs\) | | -| [`SeriesGroupBy.aggregate`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.SeriesGroupBy.aggregate.html#pandas.core.groupby.SeriesGroupBy.aggregate)\(\[func, engine, …\]\) | Aggregate using one or more operations over the specified axis. | -| [`DataFrameGroupBy.aggregate`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.aggregate.html#pandas.core.groupby.DataFrameGroupBy.aggregate)\(\[func, engine, …\]\) | Aggregate using one or more operations over the specified axis. | -| [`SeriesGroupBy.transform`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.SeriesGroupBy.transform.html#pandas.core.groupby.SeriesGroupBy.transform)\(func, \*args\[, …\]\) | Call function producing a like-indexed Series on each group and return a Series having the same indexes as the original object filled with the transformed values | -| [`DataFrameGroupBy.transform`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.transform.html#pandas.core.groupby.DataFrameGroupBy.transform)\(func, \*args\[, …\]\) | Call function producing a like-indexed DataFrame on each group and return a DataFrame having the same indexes as the original object filled with the transformed values | -| [`GroupBy.pipe`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.pipe.html#pandas.core.groupby.GroupBy.pipe)\(func, \*args, \*\*kwargs\) | Apply a function func with arguments to this GroupBy object and return the function’s result. | - -### Computations / descriptive stats - -| [`GroupBy.all`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.all.html#pandas.core.groupby.GroupBy.all)\(\[skipna\]\) | Return True if all values in the group are truthful, else False. | -| :--- | :--- | -| [`GroupBy.any`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.any.html#pandas.core.groupby.GroupBy.any)\(\[skipna\]\) | Return True if any value in the group is truthful, else False. | -| [`GroupBy.bfill`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.bfill.html#pandas.core.groupby.GroupBy.bfill)\(\[limit\]\) | Backward fill the values. | -| [`GroupBy.backfill`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.backfill.html#pandas.core.groupby.GroupBy.backfill)\(\[limit\]\) | Backward fill the values. | -| [`GroupBy.count`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.count.html#pandas.core.groupby.GroupBy.count)\(\) | Compute count of group, excluding missing values. | -| [`GroupBy.cumcount`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.cumcount.html#pandas.core.groupby.GroupBy.cumcount)\(\[ascending\]\) | Number each item in each group from 0 to the length of that group - 1. | -| [`GroupBy.cummax`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.cummax.html#pandas.core.groupby.GroupBy.cummax)\(\[axis\]\) | Cumulative max for each group. | -| [`GroupBy.cummin`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.cummin.html#pandas.core.groupby.GroupBy.cummin)\(\[axis\]\) | Cumulative min for each group. | -| [`GroupBy.cumprod`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.cumprod.html#pandas.core.groupby.GroupBy.cumprod)\(\[axis\]\) | Cumulative product for each group. | -| [`GroupBy.cumsum`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.cumsum.html#pandas.core.groupby.GroupBy.cumsum)\(\[axis\]\) | Cumulative sum for each group. | -| [`GroupBy.ffill`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.ffill.html#pandas.core.groupby.GroupBy.ffill)\(\[limit\]\) | Forward fill the values. | -| [`GroupBy.first`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.first.html#pandas.core.groupby.GroupBy.first)\(\[numeric\_only, min\_count\]\) | Compute first of group values. | -| [`GroupBy.head`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.head.html#pandas.core.groupby.GroupBy.head)\(\[n\]\) | Return first n rows of each group. | -| [`GroupBy.last`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.last.html#pandas.core.groupby.GroupBy.last)\(\[numeric\_only, min\_count\]\) | Compute last of group values. | -| [`GroupBy.max`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.max.html#pandas.core.groupby.GroupBy.max)\(\[numeric\_only, min\_count\]\) | Compute max of group values. | -| [`GroupBy.mean`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.mean.html#pandas.core.groupby.GroupBy.mean)\(\[numeric\_only\]\) | Compute mean of groups, excluding missing values. | -| [`GroupBy.median`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.median.html#pandas.core.groupby.GroupBy.median)\(\[numeric\_only\]\) | Compute median of groups, excluding missing values. | -| [`GroupBy.min`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.min.html#pandas.core.groupby.GroupBy.min)\(\[numeric\_only, min\_count\]\) | Compute min of group values. | -| [`GroupBy.ngroup`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.ngroup.html#pandas.core.groupby.GroupBy.ngroup)\(\[ascending\]\) | Number each group from 0 to the number of groups - 1. | -| [`GroupBy.nth`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.nth.html#pandas.core.groupby.GroupBy.nth)\(n\[, dropna\]\) | Take the nth row from each group if n is an int, or a subset of rows if n is a list of ints. | -| [`GroupBy.ohlc`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.ohlc.html#pandas.core.groupby.GroupBy.ohlc)\(\) | Compute open, high, low and close values of a group, excluding missing values. | -| [`GroupBy.pad`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.pad.html#pandas.core.groupby.GroupBy.pad)\(\[limit\]\) | Forward fill the values. | -| [`GroupBy.prod`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.prod.html#pandas.core.groupby.GroupBy.prod)\(\[numeric\_only, min\_count\]\) | Compute prod of group values. | -| [`GroupBy.rank`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.rank.html#pandas.core.groupby.GroupBy.rank)\(\[method, ascending, na\_option, …\]\) | Provide the rank of values within each group. | -| [`GroupBy.pct_change`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.pct_change.html#pandas.core.groupby.GroupBy.pct_change)\(\[periods, fill\_method, …\]\) | Calculate pct\_change of each value to previous entry in group. | -| [`GroupBy.size`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.size.html#pandas.core.groupby.GroupBy.size)\(\) | Compute group sizes. | -| [`GroupBy.sem`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.sem.html#pandas.core.groupby.GroupBy.sem)\(\[ddof\]\) | Compute standard error of the mean of groups, excluding missing values. | -| [`GroupBy.std`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.std.html#pandas.core.groupby.GroupBy.std)\(\[ddof\]\) | Compute standard deviation of groups, excluding missing values. | -| [`GroupBy.sum`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.sum.html#pandas.core.groupby.GroupBy.sum)\(\[numeric\_only, min\_count\]\) | Compute sum of group values. | -| [`GroupBy.var`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.var.html#pandas.core.groupby.GroupBy.var)\(\[ddof\]\) | Compute variance of groups, excluding missing values. | -| [`GroupBy.tail`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.tail.html#pandas.core.groupby.GroupBy.tail)\(\[n\]\) | Return last n rows of each group. | - -The following methods are available in both `SeriesGroupBy` and `DataFrameGroupBy` objects, but may differ slightly, usually in that the `DataFrameGroupBy` version usually permits the specification of an axis argument, and often an argument indicating whether to restrict application to columns of a specific data type. - -| [`DataFrameGroupBy.all`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.all.html#pandas.core.groupby.DataFrameGroupBy.all)\(\[skipna\]\) | Return True if all values in the group are truthful, else False. | -| :--- | :--- | -| [`DataFrameGroupBy.any`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.any.html#pandas.core.groupby.DataFrameGroupBy.any)\(\[skipna\]\) | Return True if any value in the group is truthful, else False. | -| [`DataFrameGroupBy.backfill`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.backfill.html#pandas.core.groupby.DataFrameGroupBy.backfill)\(\[limit\]\) | Backward fill the values. | -| [`DataFrameGroupBy.bfill`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.bfill.html#pandas.core.groupby.DataFrameGroupBy.bfill)\(\[limit\]\) | Backward fill the values. | -| [`DataFrameGroupBy.corr`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.corr.html#pandas.core.groupby.DataFrameGroupBy.corr) | Compute pairwise correlation of columns, excluding NA/null values. | -| [`DataFrameGroupBy.count`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.count.html#pandas.core.groupby.DataFrameGroupBy.count)\(\) | Compute count of group, excluding missing values. | -| [`DataFrameGroupBy.cov`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.cov.html#pandas.core.groupby.DataFrameGroupBy.cov) | Compute pairwise covariance of columns, excluding NA/null values. | -| [`DataFrameGroupBy.cumcount`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.cumcount.html#pandas.core.groupby.DataFrameGroupBy.cumcount)\(\[ascending\]\) | Number each item in each group from 0 to the length of that group - 1. | -| [`DataFrameGroupBy.cummax`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.cummax.html#pandas.core.groupby.DataFrameGroupBy.cummax)\(\[axis\]\) | Cumulative max for each group. | -| [`DataFrameGroupBy.cummin`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.cummin.html#pandas.core.groupby.DataFrameGroupBy.cummin)\(\[axis\]\) | Cumulative min for each group. | -| [`DataFrameGroupBy.cumprod`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.cumprod.html#pandas.core.groupby.DataFrameGroupBy.cumprod)\(\[axis\]\) | Cumulative product for each group. | -| [`DataFrameGroupBy.cumsum`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.cumsum.html#pandas.core.groupby.DataFrameGroupBy.cumsum)\(\[axis\]\) | Cumulative sum for each group. | -| [`DataFrameGroupBy.describe`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.describe.html#pandas.core.groupby.DataFrameGroupBy.describe)\(\*\*kwargs\) | Generate descriptive statistics. | -| [`DataFrameGroupBy.diff`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.diff.html#pandas.core.groupby.DataFrameGroupBy.diff) | First discrete difference of element. | -| [`DataFrameGroupBy.ffill`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.ffill.html#pandas.core.groupby.DataFrameGroupBy.ffill)\(\[limit\]\) | Forward fill the values. | -| [`DataFrameGroupBy.fillna`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.fillna.html#pandas.core.groupby.DataFrameGroupBy.fillna) | Fill NA/NaN values using the specified method. | -| [`DataFrameGroupBy.filter`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.filter.html#pandas.core.groupby.DataFrameGroupBy.filter)\(func\[, dropna\]\) | Return a copy of a DataFrame excluding filtered elements. | -| [`DataFrameGroupBy.hist`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.hist.html#pandas.core.groupby.DataFrameGroupBy.hist) | Make a histogram of the DataFrame’s. | -| [`DataFrameGroupBy.idxmax`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.idxmax.html#pandas.core.groupby.DataFrameGroupBy.idxmax) | Return index of first occurrence of maximum over requested axis. | -| [`DataFrameGroupBy.idxmin`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.idxmin.html#pandas.core.groupby.DataFrameGroupBy.idxmin) | Return index of first occurrence of minimum over requested axis. | -| [`DataFrameGroupBy.mad`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.mad.html#pandas.core.groupby.DataFrameGroupBy.mad) | Return the mean absolute deviation of the values for the requested axis. | -| [`DataFrameGroupBy.nunique`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.nunique.html#pandas.core.groupby.DataFrameGroupBy.nunique)\(\[dropna\]\) | Return DataFrame with counts of unique elements in each position. | -| [`DataFrameGroupBy.pad`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.pad.html#pandas.core.groupby.DataFrameGroupBy.pad)\(\[limit\]\) | Forward fill the values. | -| [`DataFrameGroupBy.pct_change`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.pct_change.html#pandas.core.groupby.DataFrameGroupBy.pct_change)\(\[periods, …\]\) | Calculate pct\_change of each value to previous entry in group. | -| [`DataFrameGroupBy.plot`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.plot.html#pandas.core.groupby.DataFrameGroupBy.plot) | Class implementing the .plot attribute for groupby objects. | -| [`DataFrameGroupBy.quantile`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.quantile.html#pandas.core.groupby.DataFrameGroupBy.quantile)\(\[q, interpolation\]\) | Return group values at the given quantile, a la numpy.percentile. | -| [`DataFrameGroupBy.rank`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.rank.html#pandas.core.groupby.DataFrameGroupBy.rank)\(\[method, ascending, …\]\) | Provide the rank of values within each group. | -| [`DataFrameGroupBy.resample`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.resample.html#pandas.core.groupby.DataFrameGroupBy.resample)\(rule, \*args, \*\*kwargs\) | Provide resampling when using a TimeGrouper. | -| [`DataFrameGroupBy.sample`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.sample.html#pandas.core.groupby.DataFrameGroupBy.sample)\(\[n, frac, replace, …\]\) | Return a random sample of items from each group. | -| [`DataFrameGroupBy.shift`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.shift.html#pandas.core.groupby.DataFrameGroupBy.shift)\(\[periods, freq, …\]\) | Shift each group by periods observations. | -| [`DataFrameGroupBy.size`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.size.html#pandas.core.groupby.DataFrameGroupBy.size)\(\) | Compute group sizes. | -| [`DataFrameGroupBy.skew`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.skew.html#pandas.core.groupby.DataFrameGroupBy.skew) | Return unbiased skew over requested axis. | -| [`DataFrameGroupBy.take`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.take.html#pandas.core.groupby.DataFrameGroupBy.take) | Return the elements in the given _positional_ indices along an axis. | -| [`DataFrameGroupBy.tshift`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.tshift.html#pandas.core.groupby.DataFrameGroupBy.tshift) | \(DEPRECATED\) Shift the time index, using the index’s frequency if available. | - -The following methods are available only for `SeriesGroupBy` objects. - -| [`SeriesGroupBy.hist`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.SeriesGroupBy.hist.html#pandas.core.groupby.SeriesGroupBy.hist) | Draw histogram of the input series using matplotlib. | -| :--- | :--- | -| [`SeriesGroupBy.nlargest`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.SeriesGroupBy.nlargest.html#pandas.core.groupby.SeriesGroupBy.nlargest) | Return the largest n elements. | -| [`SeriesGroupBy.nsmallest`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.SeriesGroupBy.nsmallest.html#pandas.core.groupby.SeriesGroupBy.nsmallest) | Return the smallest n elements. | -| [`SeriesGroupBy.nunique`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.SeriesGroupBy.nunique.html#pandas.core.groupby.SeriesGroupBy.nunique)\(\[dropna\]\) | Return number of unique elements in the group. | -| [`SeriesGroupBy.unique`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.SeriesGroupBy.unique.html#pandas.core.groupby.SeriesGroupBy.unique) | Return unique values of Series object. | -| [`SeriesGroupBy.value_counts`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.SeriesGroupBy.value_counts.html#pandas.core.groupby.SeriesGroupBy.value_counts)\(\[normalize, …\]\) | | -| [`SeriesGroupBy.is_monotonic_increasing`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.SeriesGroupBy.is_monotonic_increasing.html#pandas.core.groupby.SeriesGroupBy.is_monotonic_increasing) | Alias for is\_monotonic. | -| [`SeriesGroupBy.is_monotonic_decreasing`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.SeriesGroupBy.is_monotonic_decreasing.html#pandas.core.groupby.SeriesGroupBy.is_monotonic_decreasing) | Return boolean if values in the object are monotonic\_decreasing. | - -The following methods are available only for `DataFrameGroupBy` objects. - -| [`DataFrameGroupBy.corrwith`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.corrwith.html#pandas.core.groupby.DataFrameGroupBy.corrwith) | Compute pairwise correlation. | -| :--- | :--- | -| [`DataFrameGroupBy.boxplot`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.boxplot.html#pandas.core.groupby.DataFrameGroupBy.boxplot)\(\[subplots, column, …\]\) | Make box plots from DataFrameGroupBy data. | - diff --git a/api-reference-v1-stable/groupby/README.md b/api-reference-v1-stable/groupby/README.md deleted file mode 100644 index 9a1db65..0000000 --- a/api-reference-v1-stable/groupby/README.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -description: 'GroupBy objects are returned by groupby calls: danfo.DataFrame.groupby()' ---- - -# Groupby - -### Indexing, iteration - -| | | -| :--- | :--- | -| [`GroupBy.get_group`](groupby.get_groups.md) | Construct DataFrame from group with provided name. | - -### Function application - -| | | -| :--- | :--- | -| [`GroupBy.agg`](groupby.agg.md) | Aggregate using one or more operations over the specified axis. | - -### Computations / descriptive stats - -| | | -| :--- | :--- | -| [`GroupBy.count`](groupby.count.md) | Compute count of group, excluding missing values. | -| [`GroupBy.cummax`](groupby.cummax.md) | Cumulative max for each group. | -| [`GroupBy.cummin`](groupby.cummin.md) | Cumulative min for each group. | -| [`GroupBy.cumprod`](groupby.cumprod.md) | Cumulative product for each group. | -| [`GroupBy.cumsum`](groupby.cumsum.md) | Cumulative sum for each group. | -| [`GroupBy.max`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.max.html#pandas.core.groupby.GroupBy.max) | Compute max of group values. | -| [`GroupBy.mean`](groupby.mean.md) | Compute mean of groups, excluding missing values. | -| [`GroupBy.min`](groupby.min.md) | Compute min of group values. | -| [`GroupBy.std`](groupby.std.md) | Compute standard deviation of groups, excluding missing values. | -| [`GroupBy.sum`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.GroupBy.sum.html#pandas.core.groupby.GroupBy.sum) | Compute sum of group values. | -| [`GroupBy.var`](groupby.var.md) | Compute variance of groups, excluding missing values. | - diff --git a/api-reference-v1-stable/groupby/groupby.agg.md b/api-reference-v1-stable/groupby/groupby.agg.md deleted file mode 100644 index fae8802..0000000 --- a/api-reference-v1-stable/groupby/groupby.agg.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -description: Obtain data aggregate per groups for each column ---- - -# Groupby.agg - -> danfo.Groupby.**agg**(kwargs) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/groupby.js#L349)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------------------------------------------------- | ------- | -| kwargs | Object | kwargs contain keys which are column names in the dataframe, and the values are operation to be performed | | - -**Return:** DataFrame - -**Examples** - -Using mean and sum aggregate - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - -let grp = df.groupby(["A"]) -grp.agg({"C":"mean","D":"sum"}).print() -``` -{% endtab %} -{% endtabs %} - -``` - Shape: (2,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ C_mean │ D_sum ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ 4.19999980926... │ 27 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ bar │ 3 │ 9 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -Mean and Sum aggregate on dataframe groupby two column - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - -let grp = df.groupby(["A","B"]) -grp.agg({"C":"mean","D":"sum"}).print() -``` -{% endtab %} -{% endtabs %} - -``` - Shape: (5,4) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_mean │ D_sum ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ one │ 3.5 │ 10 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ two │ 3.5 │ 9 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ three │ 7 │ 8 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ bar │ one │ 3 │ 2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ bar │ two │ 2 │ 6 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` diff --git a/api-reference-v1-stable/groupby/groupby.apply.md b/api-reference-v1-stable/groupby/groupby.apply.md deleted file mode 100644 index 2150a21..0000000 --- a/api-reference-v1-stable/groupby/groupby.apply.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -description: Apply custom aggregate function to grouped data ---- - -# Groupby.apply - -danfo.Groupby.**apply**\(callable\) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs-node/src/core/groupby.js#L297)\] - -| Parameters | Type | Description | Default | -| :--- | :--- | :--- | :--- | -| callable | Function \| function to be applied to grouped data | Undefined | | - -**Returns:** - - ****return **DataFrame** - -## **Examples** - -Using apply to create a custom function that subtract the minimum value of each grouped data from each of its values - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = { - 'A': ['foo', 'bar', 'foo', 'bar', - - 'foo', 'bar', 'foo', 'foo'], - - 'B': ['one', 'one', 'two', 'three', - - 'two', 'two', 'one', 'three'], - - 'C': [1, 3, 2, 4, 5, 2, 6, 7], - - 'D': [3, 2, 4, 1, 5, 6, 7, 8] - }; -let df = new dfd.DataFrame(data); -let group_df = df.groupby(["A", "B"]); - -const subMin = (x) => { - return x.sub(x.min()); -}; - -group_df.apply(subMin).print(); - -``` -{% endtab %} - -{% tab title="Browser" %} -``` - -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```text -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_apply │ D_apply ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ one │ 0 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ one │ 5 │ 4 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ two │ 0 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ foo │ two │ 3 │ 1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ foo │ three │ 0 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 5 │ bar │ one │ 0 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 6 │ bar │ two │ 0 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 7 │ bar │ three │ 0 │ 0 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` -{% endtab %} -{% endtabs %} - -\*\*\*\* diff --git a/api-reference-v1-stable/groupby/groupby.col.md b/api-reference-v1-stable/groupby/groupby.col.md deleted file mode 100644 index 02e7cdd..0000000 --- a/api-reference-v1-stable/groupby/groupby.col.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -description: Obtain the column(s) per groups ---- - -# Groupby.col - -> danfo.Groupby.col\(col\_names\) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/groupby.js#L104)\] - -| Parameters | Type | Description | Default | -| :--- | :--- | :--- | :--- | -| col\_names | Array | List of column | | - -Returns: Groupby Data structure - -Note: This is similar to pandas `df.groupby(["column"])["col_names"]` - -**Examples** - -Obtain a column - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - - -let grp = df.groupby(["A"]) -grp.col(["C"]) - -//for more coumns -grp.col(["C","D"]) -``` -{% endtab %} -{% endtabs %} - -Apparently the output are not that useful unless you perform some operations like max\(\), count\(\) and the likes. - -```text -//it returns the groupby data structure -GroupBy { - key_col: [ 'A' ], - col_dict: { - foo: [ [Array], [Array], [Array], [Array], [Array] ], - bar: [ [Array], [Array], [Array] ] - }, - data: [ - [ 'foo', 'one', 1, 3 ], - [ 'bar', 'one', 3, 2 ], - [ 'foo', 'two', 2, 4 ], - [ 'bar', 'three', 4, 1 ], - [ 'foo', 'two', 5, 5 ], - [ 'bar', 'two', 2, 6 ], - [ 'foo', 'one', 6, 7 ], - [ 'foo', 'three', 7, 8 ] - ], - column_name: [ 'A', 'B', 'C', 'D' ], - data_tensors: { - foo: DataFrame { - kwargs: [Object], - series: false, - data: [Array], - row_data_tensor: [Tensor], - index_arr: [Array], - columns: [Array], - col_data: [Array], - col_data_tensor: [Tensor], - col_types: [Array], - A: [Getter/Setter], - B: [Getter/Setter], - C: [Getter/Setter], - D: [Getter/Setter] - }, - bar: DataFrame { - kwargs: [Object], - series: false, - data: [Array], - row_data_tensor: [Tensor], - index_arr: [Array], - columns: [Array], - col_data: [Array], - col_data_tensor: [Tensor], - col_types: [Array], - A: [Getter/Setter], - B: [Getter/Setter], - C: [Getter/Setter], - D: [Getter/Setter] - } - }, - group_col_name: [ 'C' ], - group_col: { foo: [ [Series] ], bar: [ [Series] ] } -} -``` - - - diff --git a/api-reference-v1-stable/groupby/groupby.count.md b/api-reference-v1-stable/groupby/groupby.count.md deleted file mode 100644 index 36733be..0000000 --- a/api-reference-v1-stable/groupby/groupby.count.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -description: Count the occurrence of values in columns per groups ---- - -# Groupby.count - -> danfo.Groupby.count() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/groupby.js#L249)] - -**Parameters**: None - -**Return**: DataFrame - -**Examples** - -Obtain the variance of a column for each group, group by one column - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - - -let grp = df.groupby(["A"]) -grp.col(["C"]).count().print() -``` -{% endtab %} -{% endtabs %} - -``` - - Shape: (2,2) - -╔═══╤═══════════════════╤═══════════════════╗ -║ │ A │ C_count ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ foo │ 5 ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ bar │ 3 ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` - -Obtain the var for two columns for each group, group by one column - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - -let grp = df.groupby(["A"]) -grp.col(["C","D"]).count().print() -``` -{% endtab %} -{% endtabs %} - -``` - Shape: (2,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ C_count │ D_count ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ 5 │ 5 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ bar │ 3 │ 3 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -Obtain the count for a column for each group, group by two columns - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - -let grp = df.groupby(["A","B"]) -grp.col(["C"]).count().print() - -``` -{% endtab %} -{% endtabs %} - -``` - Shape: (5,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_count ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ one │ 2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ two │ 2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ three │ 1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ bar │ one │ 1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ bar │ two │ 1 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -Obtain the count for two columns for each group, group by two columns - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - -let grp = df.groupby(["A","B"]) -grp.col(["C","D"]).count().print() -``` -{% endtab %} -{% endtabs %} - -``` - - Shape: (5,4) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_count │ D_count ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ one │ 2 │ 2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ two │ 2 │ 2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ three │ 1 │ 1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ bar │ one │ 1 │ 1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ bar │ two │ 1 │ 1 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -**** diff --git a/api-reference-v1-stable/groupby/groupby.cummax.md b/api-reference-v1-stable/groupby/groupby.cummax.md deleted file mode 100644 index 8231a61..0000000 --- a/api-reference-v1-stable/groupby/groupby.cummax.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -description: Obtain the cummulative max per groups for each column ---- - -# Groupby.cummax - -> danfo.Groupby.cummax\(\) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/groupby.js#L285)\] - -**Parameters**: None - -**Return**: DataFrame - -**Examples** - -Obtain the cumulative max of a column for each groups, group by one column - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - -let grp = df.groupby(["A"]) -grp.col(["C"]).cummax().head().print() -grp.col(["C"]).cummax().tail().print() -``` -{% endtab %} -{% endtabs %} - -```text - -Shape: (5,2) - -╔═══╤═══════════════════╤═══════════════════╗ -║ │ A │ C_cummax ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ foo │ 1 ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ foo │ 2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ foo │ 5 ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ foo │ 6 ║ -╟───┼───────────────────┼───────────────────╢ -║ 4 │ foo │ 7 ║ -╚═══╧═══════════════════╧═══════════════════╝ - - - Shape: (5,2) - -╔═══╤═══════════════════╤═══════════════════╗ -║ │ A │ C_cummax ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ foo │ 6 ║ -╟───┼───────────────────┼───────────────────╢ -║ 4 │ foo │ 7 ║ -╟───┼───────────────────┼───────────────────╢ -║ 5 │ bar │ 3 ║ -╟───┼───────────────────┼───────────────────╢ -║ 6 │ bar │ 4 ║ -╟───┼───────────────────┼───────────────────╢ -║ 7 │ bar │ 4 ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` - -Obtain the cumsum for two columns for each group, group by one column - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - -let grp = df.groupby(["A"]) -grp.col(["C","D"]).cummax().head().print() -grp.col(["C","D"]).cummax().tail().print() -``` -{% endtab %} -{% endtabs %} - -```text - - Shape: (5,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ C_cummax │ D_cummax ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ 1 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ 2 │ 4 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ 5 │ 5 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ foo │ 6 │ 7 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ foo │ 7 │ 8 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - Shape: (5,3) - -╔════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ C_cummax │ D_cummax ║ -╟────┼───────────────────┼───────────────────┼───────────────────╢ -║ 11 │ bar │ 4 │ 2 ║ -╟────┼───────────────────┼───────────────────┼───────────────────╢ -║ 12 │ bar │ 4 │ 6 ║ -╟────┼───────────────────┼───────────────────┼───────────────────╢ -║ 13 │ bar │ 3 │ 2 ║ -╟────┼───────────────────┼───────────────────┼───────────────────╢ -║ 14 │ bar │ 4 │ 2 ║ -╟────┼───────────────────┼───────────────────┼───────────────────╢ -║ 15 │ bar │ 4 │ 6 ║ -╚════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -Obtain the cummax for a column for each group, group by two columns - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - -let grp = df.groupby(["A","B"]) -grp.col(["C"]).cummax().head().print() -grp.col(["C"]).cummax().tail().print() - -``` -{% endtab %} -{% endtabs %} - -```text - Shape: (5,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_cummax ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ one │ 1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ one │ 6 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ two │ 2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ foo │ two │ 5 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ foo │ three │ 7 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - Shape: (5,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_cummax ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ foo │ two │ 5 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ foo │ three │ 7 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 5 │ bar │ one │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 6 │ bar │ two │ 2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 7 │ bar │ three │ 4 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -Obtain the cummax for two columns for each group, group by two columns - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - -let grp = df.groupby(["A","B"]) -grp.col(["C","D"]).cummax().head().print() -grp.col(["C","D"]).cummax().tail().print() -``` -{% endtab %} -{% endtabs %} - -```text - - Shape: (5,4) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_cummax │ D_cummax ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ one │ 1 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ one │ 6 │ 7 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ two │ 2 │ 4 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ foo │ two │ 5 │ 5 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ foo │ three │ 7 │ 8 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - Shape: (5,4) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_cummax │ D_cummax ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ foo │ two │ 5 │ 5 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ foo │ three │ 7 │ 8 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 5 │ bar │ one │ 3 │ 2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 6 │ bar │ two │ 2 │ 6 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 7 │ bar │ three │ 4 │ 1 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - diff --git a/api-reference-v1-stable/groupby/groupby.cumprod.md b/api-reference-v1-stable/groupby/groupby.cumprod.md deleted file mode 100644 index af46123..0000000 --- a/api-reference-v1-stable/groupby/groupby.cumprod.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -description: Obtain the cumulative product per group for each column ---- - -# Groupby.cumprod - -> danfo.Groupby.**cumprod**\(\) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/groupby.js#L291)\] - -**Parameters**: None - -**Return**: DataFrame - -**Examples** - -Obtain the cumulative product of a column for each groups, group by one column - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - -let grp = df.groupby(["A"]) -grp.col(["C"]).cumprod().head().print() -grp.col(["C"]).cumprod().tail().print() -``` -{% endtab %} -{% endtabs %} - -```text - - Shape: (5,2) - -╔═══╤═══════════════════╤═══════════════════╗ -║ │ A │ C_cumprod ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ foo │ 1 ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ foo │ 2 ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ foo │ 10 ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ foo │ 60 ║ -╟───┼───────────────────┼───────────────────╢ -║ 4 │ foo │ 420 ║ -╚═══╧═══════════════════╧═══════════════════╝ - - - Shape: (5,2) - -╔═══╤═══════════════════╤═══════════════════╗ -║ │ A │ C_cumprod ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ foo │ 60 ║ -╟───┼───────────────────┼───────────────────╢ -║ 4 │ foo │ 420 ║ -╟───┼───────────────────┼───────────────────╢ -║ 5 │ bar │ 3 ║ -╟───┼───────────────────┼───────────────────╢ -║ 6 │ bar │ 12 ║ -╟───┼───────────────────┼───────────────────╢ -║ 7 │ bar │ 24 ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` - -Obtain the cumprod for two columns for each groups, group by one column - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - -let grp = df.groupby(["A"]) -grp.col(["C","D"]).cumprod().head().print() -grp.col(["C","D"]).cumprod().tail().print() -``` -{% endtab %} -{% endtabs %} - -```text - -Shape: (5,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ C_cumprod │ D_cumprod ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ 1 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ 2 │ 12 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ 10 │ 60 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ foo │ 60 │ 420 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ foo │ 420 │ 3360 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - Shape: (5,3) - -╔════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ C_cumprod │ D_cumprod ║ -╟────┼───────────────────┼───────────────────┼───────────────────╢ -║ 11 │ bar │ 12 │ 2 ║ -╟────┼───────────────────┼───────────────────┼───────────────────╢ -║ 12 │ bar │ 24 │ 12 ║ -╟────┼───────────────────┼───────────────────┼───────────────────╢ -║ 13 │ bar │ 3 │ 2 ║ -╟────┼───────────────────┼───────────────────┼───────────────────╢ -║ 14 │ bar │ 12 │ 2 ║ -╟────┼───────────────────┼───────────────────┼───────────────────╢ -║ 15 │ bar │ 24 │ 12 ║ -╚════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -Obtain the cumprod for a column for each group, group by two columns - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - -let grp = df.groupby(["A","B"]) -grp.col(["C"]).cumprod().head().print() -grp.col(["C"]).cumprod().tail().print() - -``` -{% endtab %} -{% endtabs %} - -```text - Shape: (5,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_cumprod ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ one │ 1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ one │ 6 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ two │ 2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ foo │ two │ 10 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ foo │ three │ 7 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - Shape: (5,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_cumprod ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ foo │ two │ 10 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ foo │ three │ 7 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 5 │ bar │ one │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 6 │ bar │ two │ 2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 7 │ bar │ three │ 4 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -Obtain the cumprod for two columns for each group, group by two columns - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - -let grp = df.groupby(["A","B"]) -grp.col(["C","D"]).cumprod().head().print() -grp.col(["C","D"]).cumprod().tail().print() -``` -{% endtab %} -{% endtabs %} - -```text - - Shape: (5,4) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_cumprod │ D_cumprod ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ one │ 1 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ one │ 6 │ 21 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ two │ 2 │ 4 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ foo │ two │ 10 │ 20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ foo │ three │ 7 │ 8 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - Shape: (5,4) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_cumprod │ D_cumprod ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ foo │ two │ 10 │ 20 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ foo │ three │ 7 │ 8 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 5 │ bar │ one │ 3 │ 2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 6 │ bar │ two │ 2 │ 6 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 7 │ bar │ three │ 4 │ 1 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - diff --git a/api-reference-v1-stable/groupby/groupby.cumsum.md b/api-reference-v1-stable/groupby/groupby.cumsum.md deleted file mode 100644 index 3b2b0e6..0000000 --- a/api-reference-v1-stable/groupby/groupby.cumsum.md +++ /dev/null @@ -1,259 +0,0 @@ ---- -description: Obtain the cumulative sum per groups for each column ---- - -# Groupby.cumsum - -> danfo.Groupby.**cumsum**() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/groupby.js#L280)] - -**Parameters**: None - -**Return**: DataFrame - -**Examples** - -Obtain the cumulative sum of a column for each groups, group by one column - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - -let grp = df.groupby(["A"]) -grp.col(["C"]).cumsum().head().print() -grp.col(["C"]).cumsum().tail().print() -``` -{% endtab %} -{% endtabs %} - -``` - -Shape: (5,2) - -╔═══╤═══════════════════╤═══════════════════╗ -║ │ A │ C_cumsum ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ foo │ 1 ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ foo │ 3 ║ -╟───┼───────────────────┼───────────────────╢ -║ 2 │ foo │ 8 ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ foo │ 14 ║ -╟───┼───────────────────┼───────────────────╢ -║ 4 │ foo │ 21 ║ -╚═══╧═══════════════════╧═══════════════════╝ - - - Shape: (5,2) - -╔═══╤═══════════════════╤═══════════════════╗ -║ │ A │ C_cumsum ║ -╟───┼───────────────────┼───────────────────╢ -║ 3 │ foo │ 14 ║ -╟───┼───────────────────┼───────────────────╢ -║ 4 │ foo │ 21 ║ -╟───┼───────────────────┼───────────────────╢ -║ 5 │ bar │ 3 ║ -╟───┼───────────────────┼───────────────────╢ -║ 6 │ bar │ 7 ║ -╟───┼───────────────────┼───────────────────╢ -║ 7 │ bar │ 9 ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` - -Obtain the cumsum for two columns for each group, group by one column - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - -let grp = df.groupby(["A"]) -grp.col(["C","D"]).cumsum().head().print() -grp.col(["C","D"]).cumsum().tail().print() -``` -{% endtab %} -{% endtabs %} - -``` - - Shape: (5,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ C_cumsum │ D_cumsum ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ 1 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ 3 │ 7 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ 8 │ 12 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ foo │ 14 │ 19 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ foo │ 21 │ 27 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - Shape: (5,3) - -╔════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ C_cumsum │ D_cumsum ║ -╟────┼───────────────────┼───────────────────┼───────────────────╢ -║ 11 │ bar │ 7 │ 3 ║ -╟────┼───────────────────┼───────────────────┼───────────────────╢ -║ 12 │ bar │ 9 │ 9 ║ -╟────┼───────────────────┼───────────────────┼───────────────────╢ -║ 13 │ bar │ 3 │ 2 ║ -╟────┼───────────────────┼───────────────────┼───────────────────╢ -║ 14 │ bar │ 7 │ 3 ║ -╟────┼───────────────────┼───────────────────┼───────────────────╢ -║ 15 │ bar │ 9 │ 9 ║ -╚════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -Obtain the cumsum for a column for each group, group by two columns - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - -let grp = df.groupby(["A","B"]) -grp.col(["C"]).cumsum().head().print() -grp.col(["C"]).cumsum().tail().print() - -``` -{% endtab %} -{% endtabs %} - -``` - Shape: (5,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_cumsum ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ one │ 1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ one │ 7 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ two │ 2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ foo │ two │ 7 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ foo │ three │ 7 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - Shape: (5,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_cumsum ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ foo │ two │ 7 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ foo │ three │ 7 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 5 │ bar │ one │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 6 │ bar │ two │ 2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 7 │ bar │ three │ 4 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -Obtain the count for two columns for each group, group by two columns - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - -let grp = df.groupby(["A","B"]) -grp.col(["C","D"]).cumsum().head().print() -grp.col(["C","D"]).cumsum().tail().print() -``` -{% endtab %} -{% endtabs %} - -``` - - Shape: (5,4) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_cumsum │ D_cumsum ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ one │ 1 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ one │ 7 │ 10 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ two │ 2 │ 4 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ foo │ two │ 7 │ 9 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ foo │ three │ 7 │ 8 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - - - Shape: (5,4) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_cumsum │ D_cumsum ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ foo │ two │ 7 │ 9 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ foo │ three │ 7 │ 8 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 5 │ bar │ one │ 3 │ 2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 6 │ bar │ two │ 2 │ 6 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 7 │ bar │ three │ 4 │ 1 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -**** diff --git a/api-reference-v1-stable/groupby/groupby.max.md b/api-reference-v1-stable/groupby/groupby.max.md deleted file mode 100644 index 43470f6..0000000 --- a/api-reference-v1-stable/groupby/groupby.max.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -description: Obtain the maximum value of columns per groups ---- - -# Groupby.max - -> danfo.Groupby.max() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/groupby.js#L309)] - -**Parameters:** None - -**Returns**: DataFrame - -**Example** - -Obtain the maximum value for a column for each group, group by one column - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - - -let grp = df.groupby(["A"]) -grp.col(["C"]).max().print() -``` -{% endtab %} -{% endtabs %} - -``` - Shape: (2,2) - -╔═══╤═══════════════════╤═══════════════════╗ -║ │ A │ C_max ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ foo │ 7 ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ bar │ 4 ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` - -Obtain the maximum value for two columns for each group, group by one column - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - - -let grp = df.groupby(["A"]) -grp.col(["C","D"]).max().print() -``` -{% endtab %} -{% endtabs %} - -``` - Shape: (2,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ C_max │ D_max ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ 7 │ 8 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ bar │ 4 │ 6 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -Obtain the maximum value for a column for each group, group by two columns - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - - -let grp = df.groupby(["A","B"]) -grp.col(["C"]).max().print() -``` -{% endtab %} -{% endtabs %} - -``` - Shape: (5,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_max ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ one │ 6 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ two │ 5 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ three │ 7 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ bar │ one │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ bar │ two │ 2 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -Obtain the maximum value for two columns for each group, group by two columns - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - - -let grp = df.groupby(["A","B"]) -grp.col(["C","D"]).max().print() -``` -{% endtab %} -{% endtabs %} - -``` - Shape: (5,4) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_max │ D_max ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ one │ 6 │ 7 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ two │ 5 │ 5 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ three │ 7 │ 8 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ bar │ one │ 3 │ 2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ bar │ two │ 2 │ 6 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` diff --git a/api-reference-v1-stable/groupby/groupby.mean.md b/api-reference-v1-stable/groupby/groupby.mean.md deleted file mode 100644 index add6958..0000000 --- a/api-reference-v1-stable/groupby/groupby.mean.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -description: Obtain the mean per groups for each column(s) ---- - -# Groupby.mean - -> danfo.Series.mean() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/groupby.js#L274)] - -**Parameters**: None - -**Return**: DataFrame - -**Examples** - -Obtain the mean of a column for each group, group by one column - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - - -let grp = df.groupby(["A"]) -grp.col(["C"]).mean().print() -``` -{% endtab %} -{% endtabs %} - -``` - - Shape: (2,2) - -╔═══╤═══════════════════╤═══════════════════╗ -║ │ A │ C_mean ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ foo │ 4.19999980926... ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ bar │ 3 ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` - -Obtain the mean for two columns for each group, group by one column - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - - -let grp = df.groupby(["A"]) -grp.col(["C","D"]).mean().print() -``` -{% endtab %} -{% endtabs %} - -``` - Shape: (2,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ C_mean │ D_mean ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ 4.19999980926... │ 5.40000009536... ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ bar │ 3 │ 3 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -Obtain the mean for a column for each group, group by two columns - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - - -let grp = df.groupby(["A","B"]) -grp.col(["C"]).mean().print() -``` -{% endtab %} -{% endtabs %} - -``` - Shape: (5,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_mean ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ one │ 3.5 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ two │ 3.5 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ three │ 7 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ bar │ one │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ bar │ two │ 2 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -Obtain the mean for two columns for each group, group by two columns - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - - -let grp = df.groupby(["A","B"]) -grp.col(["C","D"]).mean().print() -``` -{% endtab %} -{% endtabs %} - -``` - Shape: (5,4) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_mean │ D_mean ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ one │ 3.5 │ 5 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ two │ 3.5 │ 4.5 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ three │ 7 │ 8 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ bar │ one │ 3 │ 2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ bar │ two │ 2 │ 6 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -**** diff --git a/api-reference-v1-stable/groupby/groupby.min.md b/api-reference-v1-stable/groupby/groupby.min.md deleted file mode 100644 index 0151e64..0000000 --- a/api-reference-v1-stable/groupby/groupby.min.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -description: Obtain the minimum value per groups for a coumn(s) ---- - -# Groupby.min - -> danfo.Groupby.min() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/groupby.js#L315)] - -**Parameters**: None - -**Return**: DataFrame - -**Examples** - -Obtain the minimum value for a column for each group, group by one column - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - - -let grp = df.groupby(["A"]) -grp.col(["C"]).min().print() -``` -{% endtab %} -{% endtabs %} - -``` - Shape: (2,2) - -╔═══╤═══════════════════╤═══════════════════╗ -║ │ A │ C_min ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ foo │ 1 ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ bar │ 2 ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` - -Obtain the minimum value for two columns for each group, group by one column - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - - -let grp = df.groupby(["A"]) -grp.col(["C","D"]).min().print() -``` -{% endtab %} -{% endtabs %} - -``` - Shape: (2,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ C_min │ D_min ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ 1 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ bar │ 2 │ 1 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -Obtain the maximum value for a column for each group, group by two columns - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - - -let grp = df.groupby(["A","B"]) -grp.col(["C"]).min().print() -``` -{% endtab %} -{% endtabs %} - -``` - Shape: (5,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_min ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ one │ 1 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ two │ 2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ three │ 7 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ bar │ one │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ bar │ two │ 2 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -Obtain the maximum value for two columns for each group, group by two columns - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - - -let grp = df.groupby(["A","B"]) -grp.col(["C","D"]).min().print() -``` -{% endtab %} -{% endtabs %} - -``` - Shape: (5,4) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_min │ D_min ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ one │ 1 │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ two │ 2 │ 4 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ three │ 7 │ 8 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ bar │ one │ 3 │ 2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ bar │ two │ 2 │ 6 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -**** diff --git a/api-reference-v1-stable/groupby/groupby.std.md b/api-reference-v1-stable/groupby/groupby.std.md deleted file mode 100644 index c792a8e..0000000 --- a/api-reference-v1-stable/groupby/groupby.std.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -description: Obtain the standard deviation per groups for specified columns ---- - -# Groupby.std - -> danfo.Groupby.**std**() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/groupby.js#L262)] - -**Parameters**: None - -**Return**: DataFrame - -**Examples** - -Obtain the standard deviation of a column for each group, group by one column - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - - -let grp = df.groupby(["A"]) -grp.col(["C"]).std().print() -``` -{% endtab %} -{% endtabs %} - -``` - - Shape: (2,2) - -╔═══╤═══════════════════╤═══════════════════╗ -║ │ A │ C_std ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ foo │ 2.58843582110... ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ bar │ 1 ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` - -Obtain the std for two columns for each group, group by one column - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - -let grp = df.groupby(["A"]) -grp.col(["C","D"]).std().print() -``` -{% endtab %} -{% endtabs %} - -``` - Shape: (2,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ C_std │ D_std ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ 2.58843582110... │ 2.07364413533... ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ bar │ 1 │ 2.64575131106... ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -Obtain the std for a column for each group, group by two columns - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - -let grp = df.groupby(["A","B"]) -grp.col(["C"]).std().print() - -``` -{% endtab %} -{% endtabs %} - -``` - Shape: (5,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_std ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ one │ 3.53553390593... ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ two │ 2.12132034355... ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ three │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ bar │ one │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ bar │ two │ 0 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -Obtain the std for two columns for each group, group by two columns - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - -let grp = df.groupby(["A","B"]) -grp.col(["C","D"]).std().print() -``` -{% endtab %} -{% endtabs %} - -``` - - Shape: (5,4) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_std │ D_std ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ one │ 3.53553390593... │ 2.82842712474... ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ two │ 2.12132034355... │ 0.70710678118... ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ three │ 0 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ bar │ one │ 0 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ bar │ two │ 0 │ 0 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -**** diff --git a/api-reference-v1-stable/groupby/groupby.sum.md b/api-reference-v1-stable/groupby/groupby.sum.md deleted file mode 100644 index f6f2900..0000000 --- a/api-reference-v1-stable/groupby/groupby.sum.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -description: Obtain the sum per groups for columns ---- - -# Groupby.sum - -> danfo.Groupby.sum() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/groupby.js#L256)] - -**Parameters**: None - -**Return**: DataFrame - -**Examples** - -Obtain the sum of a column for each group, group by one column - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - - -let grp = df.groupby(["A"]) -grp.col(["C"]).sum().print() -``` -{% endtab %} -{% endtabs %} - -``` - - Shape: (2,2) - -╔═══╤═══════════════════╤═══════════════════╗ -║ │ A │ C_sum ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ foo │ 21 ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ bar │ 9 ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` - -Obtain the sum for two columns for each group, group by one column - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - - -let grp = df.groupby(["A"]) -grp.col(["C","D"]).sum().print() -``` -{% endtab %} -{% endtabs %} - -``` - Shape: (2,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ C_sum │ D_sum ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ 21 │ 27 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ bar │ 9 │ 9 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -Obtain the sum for a column for each group, group by two columns - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - - -let grp = df.groupby(["A","B"]) -grp.col(["C"]).sum().print() -``` -{% endtab %} -{% endtabs %} - -``` - Shape: (5,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_sum ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ one │ 7 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ two │ 7 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ three │ 7 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ bar │ one │ 3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ bar │ two │ 2 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -Obtain the sum for two columns for each group, group by two columns - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - - -let grp = df.groupby(["A","B"]) -grp.col(["C","D"]).sum().print() -``` -{% endtab %} -{% endtabs %} - -``` - Shape: (5,4) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_sum │ D_sum ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ one │ 7 │ 10 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ two │ 7 │ 9 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ three │ 7 │ 8 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ bar │ one │ 3 │ 2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ bar │ two │ 2 │ 6 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -**** diff --git a/api-reference-v1-stable/groupby/groupby.var.md b/api-reference-v1-stable/groupby/groupby.var.md deleted file mode 100644 index 373109f..0000000 --- a/api-reference-v1-stable/groupby/groupby.var.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -description: Obtain the variance per groups for a specified column ---- - -# Groupby.var - -> danfo.Groupby.**var**() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/groupby.js#L268)] - -**Parameters**: None - -**Return**: DataFrame - -**Examples** - -Obtain the variance of a column for each group, group by one column - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - - -let grp = df.groupby(["A"]) -grp.col(["C"]).var().print() -``` -{% endtab %} -{% endtabs %} - -``` - - Shape: (2,2) - -╔═══╤═══════════════════╤═══════════════════╗ -║ │ A │ C_var ║ -╟───┼───────────────────┼───────────────────╢ -║ 0 │ foo │ 6.7 ║ -╟───┼───────────────────┼───────────────────╢ -║ 1 │ bar │ 1 ║ -╚═══╧═══════════════════╧═══════════════════╝ -``` - -Obtain the var for two columns for each group, group by one column - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - -let grp = df.groupby(["A"]) -grp.col(["C","D"]).var().print() -``` -{% endtab %} -{% endtabs %} - -``` - Shape: (2,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ C_var │ D_var ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ 6.7 │ 4.3 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ bar │ 1 │ 7 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -Obtain the var for a column for each group, group by two columns - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - -let grp = df.groupby(["A","B"]) -grp.col(["C"]).var().print() - -``` -{% endtab %} -{% endtabs %} - -``` - Shape: (5,3) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_var ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ one │ 12.5 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ two │ 4.5 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ three │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ bar │ one │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ bar │ two │ 0 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -Obtain the var for two columns for each group, group by two columns - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data ={'A': ['foo', 'bar', 'foo', 'bar', - 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', - 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } - -let df = new dfd.DataFrame(data) - -let grp = df.groupby(["A","B"]) -grp.col(["C","D"]).var().print() -``` -{% endtab %} -{% endtabs %} - -``` - - Shape: (5,4) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_var │ D_var ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ one │ 12.5 │ 8 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ two │ 4.5 │ 0.5 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ three │ 0 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ bar │ one │ 0 │ 0 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ bar │ two │ 0 │ 0 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ -``` - -**** diff --git a/api-reference-v1-stable/input-output/README.md b/api-reference-v1-stable/input-output/README.md deleted file mode 100644 index e86d5de..0000000 --- a/api-reference-v1-stable/input-output/README.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -description: Functions for reading tabular/structured data into DataFrame/Series Objects ---- - -# Input/Output - -## CSV - -| \`\` | | -| ----------------------------------- | -------------------------------------------------------- | -| [`read_csv`](danfo.read_csv.md) | Read a comma-separated values (csv) file into DataFrame. | -| [`read_excel`](danfo.read_excel.md) | Read an Excel values (xlsx) file into DataFrame. | -| [`read_json`](danfo.read_json.md) | Read a JSON values (json) file into DataFrame. | -| [to_csv](danfo.to_csv.md) | Writes a DataFrame/Series to CSV file | -| [to_excel](danfo.to_excel.md) | Writes a DataFrame/Series to Excel file | -| [to_json](danfo.to_json.md) | Writes a DataFrame/Series to JSON file | - -Writing to `CSV` and `JSON` can also be done directly from DataFrame or Series objects (e.g. [`DataFrame.to_csv()`](../dataframe/dataframe.to_csv.md)) diff --git a/api-reference-v1-stable/input-output/danfo.read_csv.md b/api-reference-v1-stable/input-output/danfo.read_csv.md deleted file mode 100644 index a291533..0000000 --- a/api-reference-v1-stable/input-output/danfo.read_csv.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -description: >- - Reads a comma-separated values (CSV) file into DataFrame. Also supports the - reading of CSV files in chunks. ---- - -# danfo.read\_csv - -> danfo.**read\_csv**(source, configs) [\[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/io/reader.js#L21)] - -| | | | | -| -------------- | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| **Parameters** | Type | Description | Default | -| _**source**_ | File object, File path, URL |
Any valid string path is acceptable. The string could be a URL or a valid local file path.
A browser input file object is also supported.
| | -| **configs**: | object, optional | Supports all Papaparse config parameters. See [https://www.papaparse.com/docs#config](https://www.papaparse.com/docs#config). |{
dynamicTyping: true,
header: true
}
| - -**Returns:** - -\*\* \*\*_**Promise**_. Resolves to DataFrame - -The **read\_csv** method can read a CSV file from a local disk, or over the internet (URL). Reading of local files is only supported in Nodejs, while reading of input file objects is only supported in the browser. - -### **Reading files from local disk** - -By specifying a valid file path, you can load CSV files from local disk: - -{% tabs %} -{% tab title="Node.js" %} -```javascript -const dfd = require("danfojs-node") - -dfd.read_csv("./user_names.csv") //assumes file is in CWD - .then(df => { - - df.head().print() - - }).catch(err=>{ - console.log(err); - }) -``` -{% endtab %} -{% endtabs %} - -### **Reading files from a URL** - -By specifying a valid URL, you can load CSV files from any location into Danfo\*\*'\*\*s data structure: - -{% tabs %} -{% tab title="Node.js" %} -```javascript -const dfd = require("danfojs-node") - -dfd.read_csv("https://raw.githubusercontent.com/plotly/datasets/master/finance-charts-apple.csv") //assumes file is in CWD - .then(df => { - - df.head().print() - - }).catch(err=>{ - console.log(err); - }) -``` -{% endtab %} - -{% tab title="Browser" %} -```markup - - - - - - - - -{
sheet : string, (Optional) Name of the sheet which u want to parse. Default will be the first sheet.
method: The HTTP method to use.
headers: Additional headers to send with the request if reading JSON from remote url. Supports all the node-fetch options in Nodejs, and all fetch options in browsers.
}
| - -> **Returns:** -> -> ** **return** **{**Promise**} DataFrame structure of parsed Excel data - -### Example - -The **read_excel** method can read excel files saved on a local disk, or over the internet. - -{% tabs %} -{% tab title="Node.js" %} -```javascript -const dfd = require("danfojs-node") -const path = require("path") - -let local_xcel = path.join(process.cwd(), "data", "testexcel.xlxs") - -async function load_process_data() { - let df = await dfd.read_excel(local_xcel) - df.head().print() -} - -load_process_data() -``` -{% endtab %} - -{% tab title="Browser" %} -```markup - - - - - - - -Any valid string path is acceptable. The string could be a URL. Valid URL schemes include http, https, ftp, s3, gs, or a local path. Both relative and absolute paths are supported
An input file object is also supported in the browser.
| | -| options | Object |Configuration options for reading JSON files. Supported options:
{method: The HTTP method to use.
headers: Additional headers to send with the request if reading JSON from remote url. Supports all the node-fetch options in Nodejs, and all fetch options in browsers.
}
|{
method: "GET"
}
Configuration object:
{
filePath: Local file path to write the CSV file to. If not specified, the CSV will be returned as a string. Only needed in Nodejs versionfileName: The name of the file to download as. Only needed in browser environment.download: Boolean indicating whether to automatically download the CSV file in the browser. Only needed in the browser environment.
header: Boolean indicating whether to include a header row in the CSV file.
sep: Character to be used as a separator in the CSV file.
}
|{
download: true,
sep: ","
}
Configuration object:
{
filePath: Local file path to write the CSV file to. If not specified, the CSV will be returned as a string. Only needed in Nodejs versionfileName: The name of the file to download as. Only needed in the browser environment. sheetName: Name to call the excel sheet.
}
|{
filePath: "./output.xlsx",
sheetName: "Sheet1"
}
Configuration object:
{
filePath: Local file path to write the CSV file to. If not specified, the CSV will be returned as a string. Only needed in Nodejs versionfileName: The name of the file to download as. Only needed in browser environment.format: The format of the JSON. Can be one of row or column.
}
|{format: "column"
}
| Parameters - | -Type | -Description | -Default | -
|---|---|---|---|
| source - | -string | -A path to the file/resources. It can be a local file, a URL to tabular - data (CSV, EXCEL) or Datahub.io Data Resource. | -- |
| configs - | -object | -
-
- Configuration options. Supported params are: -data_num (Defaults => 0): The specific dataset to load, when - reading data from a datapackage.json, -header (Defaults => true): Whether the dataset contains a header - or not. -sheet (Defaults => 0): Number of the excel sheet which u want - to load. -} - |
- - |
| Parameters | -Type | -Description | -
|---|---|---|
| data | -1D Array, 1D Tensor, JSON object. | -Flat data structure to load into DataFrame | -
| options | -Object | -
- Optional configuration object. Supported properties are:
- index: Array of numeric or string names for subseting array. If
- not specified, indexes are auto-generated.
- dtypes: Array of data types for each the column. If not specified,
- dtypes are/is inferred.
- config: General configuration object for extending or setting NDframe - behavior. See full options here - |
-
{
inplace: false
}
| - -**Returns:** Series - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [-10, 45, 56, -25, 23, -20, 10] -let sf = new dfd.Series(data1) - -sf.abs().print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 10 ║ -╟───┼──────────────────────╢ -║ 1 │ 45 ║ -╟───┼──────────────────────╢ -║ 2 │ 56 ║ -╟───┼──────────────────────╢ -║ 3 │ 25 ║ -╟───┼──────────────────────╢ -║ 4 │ 23 ║ -╟───┼──────────────────────╢ -║ 5 │ 20 ║ -╟───┼──────────────────────╢ -║ 6 │ 10 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.add.md b/api-reference-v1-stable/series/series.add.md deleted file mode 100644 index e55b1b8..0000000 --- a/api-reference-v1-stable/series/series.add.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -description: Return Addition of series and other, element-wise (binary operator add). ---- - -# Series.add - -> danfo.Series.add(other, options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L129)] - -| Parameters | Type | Description | Default | -| ---------- | ------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------- | -| other | Series\|int\| | values | | -| options | Object | inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false |{
inplace: false
}
| - -**Return:** Series - -**Example** - -subtract from values of another series - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [30, 40, 3, 5] -let data2 = [1, 2, 3, 4] -let sf1 = new dfd.Series(data1) -let sf2 = new dfd.Series(data2) -sf1.add(sf2).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 31 ║ -╟───┼──────────────────────╢ -║ 1 │ 42 ║ -╟───┼──────────────────────╢ -║ 2 │ 6 ║ -╟───┼──────────────────────╢ -║ 3 │ 9 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -subtract from a value - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [1, 2, 3, 4, 5] -let sf1 = new dfd.Series(data1) - -sf1.add(2).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 3 ║ -╟───┼──────────────────────╢ -║ 1 │ 4 ║ -╟───┼──────────────────────╢ -║ 2 │ 5 ║ -╟───┼──────────────────────╢ -║ 3 │ 6 ║ -╟───┼──────────────────────╢ -║ 4 │ 7 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/series/series.and.md b/api-reference-v1-stable/series/series.and.md deleted file mode 100644 index 85c22cb..0000000 --- a/api-reference-v1-stable/series/series.and.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -description: >- - Returns the logical AND between Series and other. Supports element wise - operations and broadcasting. ---- - -# Series.and - -> danfo.Series.and\(other\) \[[source](https://github.com/opensource9ja/danfojs/blob/e25010c26d9c423412613d820015a48ad03d5c6d/danfojs-node/src/core/series.js#L1243)\] - -| Parameters | Type | Description | Default | -| :--- | :--- | :--- | :--- | -| other | Series, Scalar, Array of Scalars | Data to compare with | | - - **Return:** Series - -### **Logical AND between two Series object** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [false, false, false, true, false, false, true]; -let data2 = [false, false, false, false, false, false, true]; - -let sf = new dfd.Series(data1); -let sf2 = new dfd.Series(data2); -let res = sf.and(sf2) -res.print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```text -╔═══╤═══════╗ -║ 0 │ false ║ -╟───┼───────╢ -║ 1 │ false ║ -╟───┼───────╢ -║ 2 │ false ║ -╟───┼───────╢ -║ 3 │ false ║ -╟───┼───────╢ -║ 4 │ false ║ -╟───┼───────╢ -║ 5 │ false ║ -╟───┼───────╢ -║ 6 │ true ║ -╚═══╧═══════╝ -``` -{% endtab %} -{% endtabs %} - -### **Logical AND between Series and Array of the same length** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [false, false, false, true, false, false, true]; -let data2 = [false, false, false, false, false, false, true]; - -let sf = new dfd.Series(data1); -let res = sf.and(data2) -res.print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```text -╔═══╤═══════╗ -║ 0 │ false ║ -╟───┼───────╢ -║ 1 │ false ║ -╟───┼───────╢ -║ 2 │ false ║ -╟───┼───────╢ -║ 3 │ false ║ -╟───┼───────╢ -║ 4 │ false ║ -╟───┼───────╢ -║ 5 │ false ║ -╟───┼───────╢ -║ 6 │ true ║ -╚═══╧═══════╝ -``` -{% endtab %} -{% endtabs %} - -### **Logical AND between a Series and single value with broadcasting** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") -let data1 = [false, false, false, true, false, false, true]; - -let sf = new dfd.Series(data1); -let res = sf.and(false) -res.print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```text -╔═══╤═══════╗ -║ 0 │ false ║ -╟───┼───────╢ -║ 1 │ false ║ -╟───┼───────╢ -║ 2 │ false ║ -╟───┼───────╢ -║ 3 │ false ║ -╟───┼───────╢ -║ 4 │ false ║ -╟───┼───────╢ -║ 5 │ false ║ -╟───┼───────╢ -║ 6 │ false ║ -╚═══╧═══════╝ -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/series/series.append.md b/api-reference-v1-stable/series/series.append.md deleted file mode 100644 index 53e8f03..0000000 --- a/api-reference-v1-stable/series/series.append.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -description: Add a new value or values to the end of a Series. ---- - -# Series.append - -danfo.Series.**append**(newValue, index, options) \[[source](https://github.com/opensource9ja/danfojs/blob/e25010c26d9c423412613d820015a48ad03d5c6d/danfojs-node/src/core/series.js#L1120)] - -| Parameters | Type | Description | Default | -| ---------- | ------------- | -------------------------------------------------------------------------------------------------------------------------- | ------- | -| newValue | Array, Series | Object to append | | -| index | Array | The new index value(s) to append to the Series. Must contain the same number of values as `newValues` as they map `1 - 1`. | | -| options | Object |{
inplace: Whether to perform operation in-place or not.
}
| false | - -**Returns:** - - **** return **Series** - -**** - -### **Append new Series to the end of a Series** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let sf1 = new dfd.Series([1, 2, 3, 4], { index: ['f1', 'f2', 'f3', 'f4'] }) -let sf2 = new dfd.Series(["a", "b", "c"]) - -new_sf = sf1.append(sf2, ["f5", "f6", "f7"]) -new_sf.print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════╤═══╗ -║ f1 │ 1 ║ -╟────┼───╢ -║ f2 │ 2 ║ -╟────┼───╢ -║ f3 │ 3 ║ -╟────┼───╢ -║ f4 │ 4 ║ -╟────┼───╢ -║ f5 │ a ║ -╟────┼───╢ -║ f6 │ b ║ -╟────┼───╢ -║ f7 │ c ║ -╚════╧═══╝ -``` -{% endtab %} -{% endtabs %} - -### **Append new Series to the end of a Series in-place** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let sf1 = new dfd.Series([1, 2, 3, 4], { index: ['f1', 'f2', 'f3', 'f4'] }) -let sf2 = new dfd.Series(["a", "b", "c"]) -let newIndex = ["f5", "f6", "f7"] - -sf1.append(sf2, newIndex, { inplace: true }) -sf1.print() -``` -{% endtab %} -{% endtabs %} - -``` -╔════╤═══╗ -║ f1 │ 1 ║ -╟────┼───╢ -║ f2 │ 2 ║ -╟────┼───╢ -║ f3 │ 3 ║ -╟────┼───╢ -║ f4 │ 4 ║ -╟────┼───╢ -║ f5 │ a ║ -╟────┼───╢ -║ f6 │ b ║ -╟────┼───╢ -║ f7 │ c ║ -╚════╧═══╝ -``` - -### **Append an array to the end of Series** - -{% tabs %} -{% tab title="Node" %} -```javascript -let sf1 = new dfd.Series([1, 2, 3, 4], { index: ['f1', 'f2', 'f3', 'f4'] }) -let sfArr = ["a", "b", "c"] - -new_sf = sf1.append(sfArr, ["f5", "f6", "f7"]) -new_sf.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════╤═══╗ -║ f1 │ 1 ║ -╟────┼───╢ -║ f2 │ 2 ║ -╟────┼───╢ -║ f3 │ 3 ║ -╟────┼───╢ -║ f4 │ 4 ║ -╟────┼───╢ -║ f5 │ a ║ -╟────┼───╢ -║ f6 │ b ║ -╟────┼───╢ -║ f7 │ c ║ -╚════╧═══╝ - -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.apply.md b/api-reference-v1-stable/series/series.apply.md deleted file mode 100644 index 7f7050e..0000000 --- a/api-reference-v1-stable/series/series.apply.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -description: Invoke a function on each value in a Series. ---- - -# Series.apply - -> danfo.series.**apply**(callable, options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L718)] - -| Parameters | Type | Description | Default | -| ---------- | -------- | ---------------------------------------------------------------------------------------------- | ------------------------------------- | -| callable | Function | Function (can be anonymous) to apply | | -| options | Object | inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false |{
inplace: false
}
| - -**Returns:** - - **** return **Series** - -**** - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let sf = new dfd.Series([1, 2, 3, 4, 5, 6, 7, 8]) - -let apply_func = (x) => { - return x + x -} -sf.apply(apply_func).print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 2 ║ -╟───┼──────────────────────╢ -║ 1 │ 4 ║ -╟───┼──────────────────────╢ -║ 2 │ 6 ║ -╟───┼──────────────────────╢ -║ 3 │ 8 ║ -╟───┼──────────────────────╢ -║ 4 │ 10 ║ -╟───┼──────────────────────╢ -║ 5 │ 12 ║ -╟───┼──────────────────────╢ -║ 6 │ 14 ║ -╟───┼──────────────────────╢ -║ 7 │ 16 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let sf = new dfd.Series([1, 2, 3, 4, 5, 6, 7, 8]) - -sf.apply(Math.log).print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 0 ║ -╟───┼──────────────────────╢ -║ 1 │ 0.6931471805599453 ║ -╟───┼──────────────────────╢ -║ 2 │ 1.0986122886681096 ║ -╟───┼──────────────────────╢ -║ 3 │ 1.3862943611198906 ║ -╟───┼──────────────────────╢ -║ 4 │ 1.6094379124341003 ║ -╟───┼──────────────────────╢ -║ 5 │ 1.791759469228055 ║ -╟───┼──────────────────────╢ -║ 6 │ 1.9459101490553132 ║ -╟───┼──────────────────────╢ -║ 7 │ 2.0794415416798357 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let sf = new dfd.Series(["Rice","Beans","Yam","Banana","Wheat"]) - -sf.apply((x)=>{ - return x.toLocaleLowerCase() -}).print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ rice ║ -╟───┼──────────────────────╢ -║ 1 │ beans ║ -╟───┼──────────────────────╢ -║ 2 │ yam ║ -╟───┼──────────────────────╢ -║ 3 │ banana ║ -╟───┼──────────────────────╢ -║ 4 │ wheat ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/series/series.argmax.md b/api-reference-v1-stable/series/series.argmax.md deleted file mode 100644 index d7927d2..0000000 --- a/api-reference-v1-stable/series/series.argmax.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -description: Returns the int position of the largest value in the series ---- - -# Series.argmax - -> danfo.Series.argmax\(\) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L975)\] - -**Parameters**: None - -**Returns**: int - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = [1,30,20,40,50,70,90,200,10,20,12] -let sf = new dfd.Series(data) - -sf.argmax() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```text -7 -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/series/series.argmin.md b/api-reference-v1-stable/series/series.argmin.md deleted file mode 100644 index dfc661f..0000000 --- a/api-reference-v1-stable/series/series.argmin.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -description: Returns the int position of the smallest value in the series ---- - -# Series.argmin - -> danfo.Series.**argmin**\(\) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L987)\] - -**Parameters**: None - -**Returns**: int - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = [1,30,20,40,50,70,90,200,10,20,12] -let sf = new dfd.Series(data) - -sf.argmin() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```text -0 -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/series/series.argsort.md b/api-reference-v1-stable/series/series.argsort.md deleted file mode 100644 index b4608a4..0000000 --- a/api-reference-v1-stable/series/series.argsort.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -description: Return the integer indices that would sort the Series values ---- - -# Series.argsort - -> danfo.Series.**argsort**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L965\\)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | -------------------------------------- | ----------------------------------------------------- | -| options | Object | **ascending**: How to sort the indices |{
ascending: true
}
| - -**Returns:** Series (int element) - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = [10, 45, 20, 10, 23, 20, 30, 11] -let sf = new dfd.Series(data) - -sf.argsort().print() //defaults to ascending order -sf.argsort({ ascending: false }).print() - -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 0 ║ -╟───┼──────────────────────╢ -║ 1 │ 3 ║ -╟───┼──────────────────────╢ -║ 2 │ 7 ║ -╟───┼──────────────────────╢ -║ 3 │ 2 ║ -╟───┼──────────────────────╢ -║ 4 │ 5 ║ -╟───┼──────────────────────╢ -║ 5 │ 4 ║ -╟───┼──────────────────────╢ -║ 6 │ 6 ║ -╟───┼──────────────────────╢ -║ 7 │ 1 ║ -╚═══╧══════════════════════╝ - -//sorted in descending order -╔═══╤═══╗ -║ 0 │ 1 ║ -╟───┼───╢ -║ 1 │ 6 ║ -╟───┼───╢ -║ 2 │ 4 ║ -╟───┼───╢ -║ 3 │ 2 ║ -╟───┼───╢ -║ 4 │ 5 ║ -╟───┼───╢ -║ 5 │ 7 ║ -╟───┼───╢ -║ 6 │ 0 ║ -╟───┼───╢ -║ 7 │ 3 ║ -╚═══╧═══╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.astype.md b/api-reference-v1-stable/series/series.astype.md deleted file mode 100644 index 15a61ae..0000000 --- a/api-reference-v1-stable/series/series.astype.md +++ /dev/null @@ -1,2 +0,0 @@ -# Series.astype - diff --git a/api-reference-v1-stable/series/series.copy.md b/api-reference-v1-stable/series/series.copy.md deleted file mode 100644 index 9bbdb47..0000000 --- a/api-reference-v1-stable/series/series.copy.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: Makes a deep copy of a Series ---- - -# Series.copy - -> danfo.Series.copy() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L569)] - -**parameter:** - -**Return:** Series - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [30.21091, 40.190901, 3.564, 5.0212] -let sf1 = new dfd.Series(data1) -let sf2 = sf1.copy() - -sf2.print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 30.21091 ║ -╟───┼──────────────────────╢ -║ 1 │ 40.190901 ║ -╟───┼──────────────────────╢ -║ 2 │ 3.564 ║ -╟───┼──────────────────────╢ -║ 3 │ 5.0212 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.corr.md b/api-reference-v1-stable/series/series.corr.md deleted file mode 100644 index ee3263f..0000000 --- a/api-reference-v1-stable/series/series.corr.md +++ /dev/null @@ -1,2 +0,0 @@ -# Series.corr - diff --git a/api-reference-v1-stable/series/series.count.md b/api-reference-v1-stable/series/series.count.md deleted file mode 100644 index 832c794..0000000 --- a/api-reference-v1-stable/series/series.count.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -description: Obtain the total number of values in a series ---- - -# Series.count - -> danfo.Series.count() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L350)] - -**Parameter:** None - -**Return:** Number - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [20, 30, 1, 2, 4, 57, 89, 0, 4] -let sf1 = new dfd.Series(data1) - -console.log(sf1.count()) -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -9 -``` -{% endtab %} -{% endtabs %} - -**** diff --git a/api-reference-v1-stable/series/series.cummax.md b/api-reference-v1-stable/series/series.cummax.md deleted file mode 100644 index 8aded1a..0000000 --- a/api-reference-v1-stable/series/series.cummax.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -description: Returns cumulative maximum over a series ---- - -# Series.cummax - -> danfo.Series.**cummax**(options)\[[source](https://github.com/opensource9ja/danfojs/blob/e25010c26d9c423412613d820015a48ad03d5c6d/danfojs-node/src/core/series.js#L730)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------- | ------------------------------------------------------ | -| options | Object | **inplace**: Whether to perform the operation in-place or not. |{
inplace: false
}
| - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data1 = [10, 45, 56, 25, 23, 20, 10] -let sf1 = new dfd.Series(data1) - -sf1.cummax().print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 10 ║ -╟───┼──────────────────────╢ -║ 1 │ 45 ║ -╟───┼──────────────────────╢ -║ 2 │ 56 ║ -╟───┼──────────────────────╢ -║ 3 │ 56 ║ -╟───┼──────────────────────╢ -║ 4 │ 56 ║ -╟───┼──────────────────────╢ -║ 5 │ 56 ║ -╟───┼──────────────────────╢ -║ 6 │ 56 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.cummin.md b/api-reference-v1-stable/series/series.cummin.md deleted file mode 100644 index 736cee5..0000000 --- a/api-reference-v1-stable/series/series.cummin.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -description: Returns the cumulative min of a Series ---- - -# Series.cummin - -> danfo.Series.**cummin**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/e25010c26d9c423412613d820015a48ad03d5c6d/danfojs-node/src/core/series.js#L721)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------- | ------------------------------------------------------ | -| options | Object | **inplace**: Whether to perform the operation in-place or not. |{
inplace: false
}
| - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data1 = [10, 45, 56, 5, 23, 20, 10] -let sf1 = new dfd.Series(data1) - -sf1.cummin().print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 10 ║ -╟───┼──────────────────────╢ -║ 1 │ 10 ║ -╟───┼──────────────────────╢ -║ 2 │ 10 ║ -╟───┼──────────────────────╢ -║ 3 │ 5 ║ -╟───┼──────────────────────╢ -║ 4 │ 5 ║ -╟───┼──────────────────────╢ -║ 5 │ 5 ║ -╟───┼──────────────────────╢ -║ 6 │ 5 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.cumprod.md b/api-reference-v1-stable/series/series.cumprod.md deleted file mode 100644 index 84ec0e7..0000000 --- a/api-reference-v1-stable/series/series.cumprod.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -description: Return the cumulative product of a series ---- - -# Series.cumprod - -> danfo.Series.**cumprod**()\[[source](https://github.com/opensource9ja/danfojs/blob/e25010c26d9c423412613d820015a48ad03d5c6d/danfojs-node/src/core/series.js#L738)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------- | ------------------------------------------------------ | -| options | Object | **inplace**: Whether to perform the operation in-place or not. |{
inplace: false
}
| - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data1 = [10, 45, 56, 25, 23, 20, 10] -let sf1 = new dfd.Series(data1) - -sf1.cumprod().print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 10 ║ -╟───┼──────────────────────╢ -║ 1 │ 450 ║ -╟───┼──────────────────────╢ -║ 2 │ 25200 ║ -╟───┼──────────────────────╢ -║ 3 │ 630000 ║ -╟───┼──────────────────────╢ -║ 4 │ 14490000 ║ -╟───┼──────────────────────╢ -║ 5 │ 289800000 ║ -╟───┼──────────────────────╢ -║ 6 │ 2898000000 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.cumsum.md b/api-reference-v1-stable/series/series.cumsum.md deleted file mode 100644 index 7b7a19a..0000000 --- a/api-reference-v1-stable/series/series.cumsum.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -description: Return a cumulative sum of a series ---- - -# Series.cumsum - -> danfo.Series.**cumsum**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/e25010c26d9c423412613d820015a48ad03d5c6d/danfojs-node/src/core/series.js#L713)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------- | ------------------------------------------------------ | -| options | Object | **inplace**: Whether to perform the operation in-place or not. |{
inplace: false
}
| - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let data1 = [10, 45, 56, 25, 23, 20, 10] -let sf1 = new dfd.Series(data1) - -sf1.cumsum().print() -``` -{% endtab %} - -{% tab title="Browser" %} -```markup - - - - - - - -{
inplace: false
}
| - -**Return:** Series - -**Example** - -divide with values of another series - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [30, 40, 3, 5] -let data2 = [1, 2, 3, 4] -let sf1 = new dfd.Series(data1) -let sf2 = new dfd.Series(data2) -sf1.div(sf2).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 30 ║ -╟───┼──────────────────────╢ -║ 1 │ 20 ║ -╟───┼──────────────────────╢ -║ 2 │ 1 ║ -╟───┼──────────────────────╢ -║ 3 │ 1.25 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### divide with a value - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [1, 2, 3, 4, 5] -let sf1 = new dfd.Series(data1) - -sf1.div(2).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 0.5 ║ -╟───┼──────────────────────╢ -║ 1 │ 1 ║ -╟───┼──────────────────────╢ -║ 2 │ 1.5 ║ -╟───┼──────────────────────╢ -║ 3 │ 2 ║ -╟───┼──────────────────────╢ -║ 4 │ 2.5 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.dot.md b/api-reference-v1-stable/series/series.dot.md deleted file mode 100644 index 61a8bc2..0000000 --- a/api-reference-v1-stable/series/series.dot.md +++ /dev/null @@ -1,2 +0,0 @@ -# Series.dot - diff --git a/api-reference-v1-stable/series/series.drop_duplicates.md b/api-reference-v1-stable/series/series.drop_duplicates.md deleted file mode 100644 index 08edf09..0000000 --- a/api-reference-v1-stable/series/series.drop_duplicates.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -description: Remove duplicate rows ---- - -# Series.drop\_duplicates - -> danfo.Series.**drop\_duplicates**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L1007)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------- | -| options | Object |keep: "first" | "last", which duplicate value to keep. Defaults to "first".
inplace: Boolean indicating whether to perform the operation in-place or not. Defaults to false
{
inplace: false
}
| - -**Returns:** Series - -**Examples** - -### Drop duplicate by keeping the first occurrence of the duplicate value - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [10, 45, 56, 10, 23, 20, 10, 10] -let sf = new dfd.Series(data1) -let sf_drop = sf.drop_duplicates() - -sf_drop.print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 10 ║ -╟───┼──────────────────────╢ -║ 1 │ 45 ║ -╟───┼──────────────────────╢ -║ 2 │ 56 ║ -╟───┼──────────────────────╢ -║ 4 │ 23 ║ -╟───┼──────────────────────╢ -║ 5 │ 20 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Drop duplicate and keep only the last duplicated value - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [10, 45, 56, 10, 23, 20, 10, 10] -let sf = new dfd.Series(data1) -let sf_drop = sf.drop_duplicates({keep:"last"}) - -sf_drop.print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 1 │ 45 ║ -╟───┼──────────────────────╢ -║ 2 │ 56 ║ -╟───┼──────────────────────╢ -║ 4 │ 23 ║ -╟───┼──────────────────────╢ -║ 5 │ 20 ║ -╟───┼──────────────────────╢ -║ 7 │ 10 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Remove duplicate value in-place - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = ["A", "A", "A", "B", "B", "C", "C", "D"] -let sf = new dfd.Series(data1) -sf.drop_duplicates({inplace:true}) - -sf.print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ A ║ -╟───┼──────────────────────╢ -║ 3 │ B ║ -╟───┼──────────────────────╢ -║ 5 │ C ║ -╟───┼──────────────────────╢ -║ 7 │ D ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.dropna.md b/api-reference-v1-stable/series/series.dropna.md deleted file mode 100644 index 2fab716..0000000 --- a/api-reference-v1-stable/series/series.dropna.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -description: Remove missing values from Series ---- - -# Series.dropna - -> danfo.Series.**dropna**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L931)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ---------------------------------------------------------------------------------------------- | ----------------------------------- | -| options | Object | inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false |{
inplace: false
}
| - -**Returns**: Series - -**Examples** - -### Drop all nan value and then return New Series. - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [10, 45, undefined, 10, 23, 20, undefined, 10] -let sf = new dfd.Series(data1) -let sf_rep = sf.dropna() - -sf_rep.print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 10 ║ -╟───┼──────────────────────╢ -║ 1 │ 45 ║ -╟───┼──────────────────────╢ -║ 3 │ 10 ║ -╟───┼──────────────────────╢ -║ 4 │ 23 ║ -╟───┼──────────────────────╢ -║ 5 │ 20 ║ -╟───┼──────────────────────╢ -║ 7 │ 10 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Drop nan values in-place - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [10, 45, undefined, 10, 23, 20, undefined, 10] -let sf = new dfd.Series(data1) -sf.dropna({inplace:true}) - -sf.print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 10 ║ -╟───┼──────────────────────╢ -║ 1 │ 45 ║ -╟───┼──────────────────────╢ -║ 3 │ 10 ║ -╟───┼──────────────────────╢ -║ 4 │ 23 ║ -╟───┼──────────────────────╢ -║ 5 │ 20 ║ -╟───┼──────────────────────╢ -║ 7 │ 10 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.dt.day.md b/api-reference-v1-stable/series/series.dt.day.md deleted file mode 100644 index 6461fa5..0000000 --- a/api-reference-v1-stable/series/series.dt.day.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -description: Obtain the numerical representation of the week day. ---- - -# Series.dt.day - -> danfo.Series.dt.**day**() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/timeseries.js#L216)] - -**Parameters**: None - -**Returns:** Series (int elements) - -**Examples** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = new dfd.date_range({"start":'2016-12-31', "end":'2018-01-08'}) -let sf = new dfd.Series(data) - -sf.dt.day().print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -``` -╔═══╤═══╗ -║ 0 │ 6 ║ -╟───┼───╢ -║ 1 │ 0 ║ -╟───┼───╢ -║ 2 │ 1 ║ -╟───┼───╢ -║ 3 │ 2 ║ -╟───┼───╢ -║ 4 │ 3 ║ -╟───┼───╢ -║ 5 │ 4 ║ -╟───┼───╢ -║ 6 │ 5 ║ -╟───┼───╢ -║ 7 │ 6 ║ -╟───┼───╢ -║ 8 │ 0 ║ -╟───┼───╢ -║ 9 │ 1 ║ -╚═══╧═══╝ -``` diff --git a/api-reference-v1-stable/series/series.dt.hour.md b/api-reference-v1-stable/series/series.dt.hour.md deleted file mode 100644 index 16369bb..0000000 --- a/api-reference-v1-stable/series/series.dt.hour.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -description: Obtain the hours in a time series ---- - -# Series.dt.hour - -> danfo.Series.dt.**hour**() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/timeseries.js#L205)] - -**Parameters:** None - -**Returns:** Series (int elements) - -**Examples** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = new dfd.date_range({"start":"2000-01-01", period:3, freq:"H"}) -let sf = new dfd.Series(data) -// print series -sf.print() -// print hour series -sf.dt.hours().print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ 0 │ 1/1/2000, 1:00:00 AM ║ -╟───┼──────────────────────╢ -║ 1 │ 1/1/2000, 2:00:00 AM ║ -╚═══╧══════════════════════╝ - -╔═══╤═══╗ -║ 0 │ 1 ║ -╟───┼───╢ -║ 1 │ 2 ║ -╚═══╧═══╝ - -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.dt.minute.md b/api-reference-v1-stable/series/series.dt.minute.md deleted file mode 100644 index ea8bfee..0000000 --- a/api-reference-v1-stable/series/series.dt.minute.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -description: Obtain the minutes in a Time Series ---- - -# Series.dt.minutes - -> danfo.Series.dt.**minutes**() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/timeseries.js#L292)] - -**Parameters**: None - -**Returns:** Series (int Elements) - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = new dfd.date_range({"start":"2000-01-01", period:3, freq:"m"}) -let sf = new dfd.Series(data) -//print the series -sf.print() -//print the minutes series -sf.dt.minutes().print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 1/1/2000, 1:00:00 AM ║ -╟───┼──────────────────────╢ -║ 1 │ 1/1/2000, 1:01:00 AM ║ -╟───┼──────────────────────╢ -║ 2 │ 1/1/2000, 1:02:00 AM ║ -╚═══╧══════════════════════╝ - -//print the minutes series -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 0 ║ -╟───┼──────────────────────╢ -║ 1 │ 1 ║ -╟───┼──────────────────────╢ -║ 2 │ 2 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.dt.month.md b/api-reference-v1-stable/series/series.dt.month.md deleted file mode 100644 index e21eeda..0000000 --- a/api-reference-v1-stable/series/series.dt.month.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -description: Obtain the month in a date time series ---- - -# Series.dt.month - -> danfo.Series.dt.**month**() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/timeseries.js#L193)] - -**Parameters**: None - -**Returns:** Series (int elements) - -**Examples** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = new dfd.date_range({"start":'2016-7-31', "end":'2016-12-08', freq:"M"}) -let sf = new dfd.Series(data) - -sf.dt.month().print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -``` -╔═══╤════╗ -║ 0 │ 6 ║ -╟───┼────╢ -║ 1 │ 7 ║ -╟───┼────╢ -║ 2 │ 9 ║ -╟───┼────╢ -║ 3 │ 9 ║ -╟───┼────╢ -║ 4 │ 11 ║ -╟───┼────╢ -║ 5 │ 11 ║ -╚═══╧════╝ -``` diff --git a/api-reference-v1-stable/series/series.dt.month_name.md b/api-reference-v1-stable/series/series.dt.month_name.md deleted file mode 100644 index 4e83618..0000000 --- a/api-reference-v1-stable/series/series.dt.month_name.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -description: obtain the month name in a Time Series ---- - -# Series.dt.month\_name - -> danfo.Series.dt.month\_name() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/timeseries.js#L241)] - -**Parameters**: None - -**Returns:** Series (String elements) - -**Examples** - -{% tabs %} -{% tab title="Output" %} -```javascript -const dfd = require("danfojs-node") - -let data = new dfd.date_range({"start":'2018-01', freq:'M', period:3}) -let sf = new dfd.Series(data) -//print series -sf.print() -//print month names -sf.dt.month_name().print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ 0 │ 1/1/2018, 1:00:00 AM ║ -╟───┼──────────────────────╢ -║ 1 │ 2/1/2018, 1:00:00 AM ║ -╟───┼──────────────────────╢ -║ 2 │ 3/1/2018, 1:00:00 AM ║ -╚═══╧══════════════════════╝ - -╔═══╤═════╗ -║ 0 │ Jan ║ -╟───┼─────╢ -║ 1 │ Feb ║ -╟───┼─────╢ -║ 2 │ Mar ║ -╚═══╧═════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.dt.monthday.md b/api-reference-v1-stable/series/series.dt.monthday.md deleted file mode 100644 index b385f17..0000000 --- a/api-reference-v1-stable/series/series.dt.monthday.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -description: Obtain the day of the month ---- - -# Series.dt.monthday - -> danfo.Series.dt.**monthday**() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/timeseries.js#L268)] - -**Parameters:** None - -**Returns**: Series (Int elements) - -**Examples** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = new dfd.date_range({"start":"2000-01-01", period:4, freq:"D"}) -let sf = new dfd.Series(data) -//print series -sf.print() -//print monthdays -sf.dt.monthday().print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ 0 │ 1/1/2000, 1:00:00 AM ║ -╟───┼──────────────────────╢ -║ 1 │ 1/2/2000, 1:00:00 AM ║ -╟───┼──────────────────────╢ -║ 2 │ 1/3/2000, 1:00:00 AM ║ -╚═══╧══════════════════════╝ - -╔═══╤═══╗ -║ 0 │ 1 ║ -╟───┼───╢ -║ 1 │ 2 ║ -╟───┼───╢ -║ 2 │ 3 ║ -╚═══╧═══╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.dt.second.md b/api-reference-v1-stable/series/series.dt.second.md deleted file mode 100644 index 43330be..0000000 --- a/api-reference-v1-stable/series/series.dt.second.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -description: Obtain the seconds in Date series ---- - -# Series.dt.seconds - -> danfo.Series.dt.**seconds**() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/timeseries.js#L280)] - -**Parameters**: None - -**Returns:** Series (Int elements) - -**Example** - -Obtain the seconds of the datetime - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = new dfd.date_range({"start":"2000-01-01", period:3, freq:"s"}) -let sf = new dfd.Series(data) -//print the series frame -sf.print() - -//print the seconds obtained -sf.dt.seconds().print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` - -╔═══╤══════════════════════╗ -║ 0 │ 1/1/2000, 1:00:00 AM ║ -╟───┼──────────────────────╢ -║ 1 │ 1/1/2000, 1:00:01 AM ║ -╟───┼──────────────────────╢ -║ 2 │ 1/1/2000, 1:00:02 AM ║ -╚═══╧══════════════════════╝ - -╔═══╤═══╗ -║ 0 │ 0 ║ -╟───┼───╢ -║ 1 │ 1 ║ -╟───┼───╢ -║ 2 │ 2 ║ -╚═══╧═══╝ - -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.dt.weekdays.md b/api-reference-v1-stable/series/series.dt.weekdays.md deleted file mode 100644 index 04dbe18..0000000 --- a/api-reference-v1-stable/series/series.dt.weekdays.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -description: Obtain the days of the weeks ---- - -# Series.dt.weekdays - -> danfo.Series.dt.**weekdays**() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/timeseries.js#L255)] - -**Parameters**: None - -**Returns:** Series (String elements) - -**Examples** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = new dfd.date_range({"start":'2016-12-31', "end":'2017-01-08'}) -let sf = new dfd.Series(data) -//print series -sf.print() -//print days of the week -sf.dt.weekdays().print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -``` -╔═══╤════════════════════════╗ -║ 0 │ 12/31/2016, 1:00:00 AM ║ -╟───┼────────────────────────╢ -║ 1 │ 1/1/2017, 1:00:00 AM ║ -╟───┼────────────────────────╢ -║ 2 │ 1/2/2017, 1:00:00 AM ║ -╟───┼────────────────────────╢ -║ 3 │ 1/3/2017, 1:00:00 AM ║ -╟───┼────────────────────────╢ -║ 4 │ 1/4/2017, 1:00:00 AM ║ -╟───┼────────────────────────╢ -║ 5 │ 1/5/2017, 1:00:00 AM ║ -╟───┼────────────────────────╢ -║ 6 │ 1/6/2017, 1:00:00 AM ║ -╟───┼────────────────────────╢ -║ 7 │ 1/7/2017, 1:00:00 AM ║ -╟───┼────────────────────────╢ -║ 8 │ 1/8/2017, 1:00:00 AM ║ -╟───┼────────────────────────╢ -║ 9 │ 1/9/2017, 1:00:00 AM ║ -╚═══╧════════════════════════╝ - -╔═══╤══════╗ -║ 0 │ Sat ║ -╟───┼──────╢ -║ 1 │ Sun ║ -╟───┼──────╢ -║ 2 │ Mon ║ -╟───┼──────╢ -║ 3 │ Tue ║ -╟───┼──────╢ -║ 4 │ Wed ║ -╟───┼──────╢ -║ 5 │ Thur ║ -╟───┼──────╢ -║ 6 │ Fri ║ -╟───┼──────╢ -║ 7 │ Sat ║ -╟───┼──────╢ -║ 8 │ Sun ║ -╟───┼──────╢ -║ 9 │ Mon ║ -╚═══╧══════╝ -``` diff --git a/api-reference-v1-stable/series/series.dt.year.md b/api-reference-v1-stable/series/series.dt.year.md deleted file mode 100644 index ed1117f..0000000 --- a/api-reference-v1-stable/series/series.dt.year.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: Obtain the year in a date time series ---- - -# Series.dt.year - -> danfo.Series.dt.**year**() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/timeseries.js#L228)] - -**Parameters**: None - -**Returns:** Series (int elements) - -**Examples** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = new dfd.date_range({"start":"2000-01-01", period:3, freq:"Y"}) -let sf = new dfd.Series(data) -sf.print() -sf.dt.year().print() -``` -{% endtab %} -{% endtabs %} - -``` -//print date time series -╔═══╤══════════════════════╗ -║ 0 │ 1/1/2000, 1:00:00 AM ║ -╟───┼──────────────────────╢ -║ 1 │ 1/1/2001, 1:00:00 AM ║ -╟───┼──────────────────────╢ -║ 2 │ 1/1/2002, 1:00:00 AM ║ -╚═══╧══════════════════════╝ - -╔═══╤══════╗ -║ 0 │ 2000 ║ -╟───┼──────╢ -║ 1 │ 2001 ║ -╟───┼──────╢ -║ 2 │ 2002 ║ -╚═══╧══════╝ -``` diff --git a/api-reference-v1-stable/series/series.dtype.md b/api-reference-v1-stable/series/series.dtype.md deleted file mode 100644 index 75b4614..0000000 --- a/api-reference-v1-stable/series/series.dtype.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -description: Obtain the dtype of a series ---- - -# Series.dtype - -> danfo.Series.dtype \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/generic.js#L197)] - -**Parameters**: None - -**Returns:** String - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [30.21091, 40.190901, 3.564, 5.0212] -let sf1 = new dfd.Series(data1) - -console.log(sf1.dtype) -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -float32 -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.eq.md b/api-reference-v1-stable/series/series.eq.md deleted file mode 100644 index 43a3ece..0000000 --- a/api-reference-v1-stable/series/series.eq.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -description: Check all the values in a series is equal to another value ---- - -# Series.eq - -> danfo.Series.eq(other) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L894)] - -| Parameters | Type | Description | Default | -| ---------- | ----------------------- | ----------------- | ------- | -| other | Series, Array or number | value to compare | | - -**Returns**: Series (Boolean element) - -**Examples** - -Compare all the values in a series to another series - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [10, 45, 56, 25, 23, 20, 10] -let data2 = [10, 450, 56, 5, 25, 2, 0] -let sf1 = new dfd.Series(data1) -let sf2 = new dfd.Series(data2) - -sf1.eq(sf2).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ true ║ -╟───┼──────────────────────╢ -║ 1 │ false ║ -╟───┼──────────────────────╢ -║ 2 │ true ║ -╟───┼──────────────────────╢ -║ 3 │ false ║ -╟───┼──────────────────────╢ -║ 4 │ false ║ -╟───┼──────────────────────╢ -║ 5 │ false ║ -╟───┼──────────────────────╢ -║ 6 │ false ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -Check it all the values are equal to a value - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [10, 45, 56, 25, 23, 20, 10] -let sf1 = new dfd.Series(data1) - -sf1.eq(10).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ true ║ -╟───┼──────────────────────╢ -║ 1 │ false ║ -╟───┼──────────────────────╢ -║ 2 │ false ║ -╟───┼──────────────────────╢ -║ 3 │ false ║ -╟───┼──────────────────────╢ -║ 4 │ false ║ -╟───┼──────────────────────╢ -║ 5 │ false ║ -╟───┼──────────────────────╢ -║ 6 │ true ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.fillna.md b/api-reference-v1-stable/series/series.fillna.md deleted file mode 100644 index a1db3a8..0000000 --- a/api-reference-v1-stable/series/series.fillna.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -description: Replace all NaN value with specified value ---- - -# Series.fillna - -> danfo.Series.**fillna**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L470)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | -| options | Object |value: The value to replace all missing value with.
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
|{
inplace: false
}
| - -**Examples** - -### Fill nan value and then return new series - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [NaN, 1, 2, 33, 4, NaN, 5, 6, 7, 8] -let sf = new dfd.Series(data1) - -let sf_rep = sf.fillna({ value: -999}) - -sf_rep.print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ -999 ║ -╟───┼──────────────────────╢ -║ 1 │ 1 ║ -╟───┼──────────────────────╢ -║ 2 │ 2 ║ -╟───┼──────────────────────╢ -║ 3 │ 33 ║ -╟───┼──────────────────────╢ -║ 4 │ 4 ║ -╟───┼──────────────────────╢ -║ 5 │ -999 ║ -╟───┼──────────────────────╢ -║ 6 │ 5 ║ -╟───┼──────────────────────╢ -║ 7 │ 6 ║ -╟───┼──────────────────────╢ -║ 8 │ 7 ║ -╟───┼──────────────────────╢ -║ 9 │ 8 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Fill nan value in-place - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [NaN, 1, 2, 33, 4, NaN, 5, 6, 7, 8] -let sf = new dfd.Series(data1) -sf.fillna({ value: -999, inplace: true }) - -sf.print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ -999 ║ -╟───┼──────────────────────╢ -║ 1 │ 1 ║ -╟───┼──────────────────────╢ -║ 2 │ 2 ║ -╟───┼──────────────────────╢ -║ 3 │ 33 ║ -╟───┼──────────────────────╢ -║ 4 │ 4 ║ -╟───┼──────────────────────╢ -║ 5 │ -999 ║ -╟───┼──────────────────────╢ -║ 6 │ 5 ║ -╟───┼──────────────────────╢ -║ 7 │ 6 ║ -╟───┼──────────────────────╢ -║ 8 │ 7 ║ -╟───┼──────────────────────╢ -║ 9 │ 8 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.ge.md b/api-reference-v1-stable/series/series.ge.md deleted file mode 100644 index 0fb1aeb..0000000 --- a/api-reference-v1-stable/series/series.ge.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -description: Check if all the values in a series is greater than or equal a value ---- - -# Series.ge - -> danfo.Series.ge(other) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L874)] - -| Parameters | Type | Description | Default | -| ---------- | ----------------------- | ------------------- | ------- | -| other | Series, Array or number | value(s) to compare | | - -**Returns:** Series (Boolean element) - -**Example** - -Compare all the value in a Series to the values in another series - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [10, 45, 56, 25, 23, 20, 10] -let data2 = [10, 450, 56, 5, 25, 2, 0] -let sf1 = new dfd.Series(data1) -let sf2 = new dfd.Series(data2) - -sf1.ge(sf2).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ true ║ -╟───┼──────────────────────╢ -║ 1 │ false ║ -╟───┼──────────────────────╢ -║ 2 │ true ║ -╟───┼──────────────────────╢ -║ 3 │ true ║ -╟───┼──────────────────────╢ -║ 4 │ false ║ -╟───┼──────────────────────╢ -║ 5 │ true ║ -╟───┼──────────────────────╢ -║ 6 │ true ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -Check if all the value in a Series is greater than or equal a value. - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [10, 45, 56, 25, 23, 20, 10] -let sf1 = new dfd.Series(data1) - -sf1.ge(20).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ false ║ -╟───┼──────────────────────╢ -║ 1 │ true ║ -╟───┼──────────────────────╢ -║ 2 │ true ║ -╟───┼──────────────────────╢ -║ 3 │ true ║ -╟───┼──────────────────────╢ -║ 4 │ true ║ -╟───┼──────────────────────╢ -║ 5 │ true ║ -╟───┼──────────────────────╢ -║ 6 │ false ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.gt.md b/api-reference-v1-stable/series/series.gt.md deleted file mode 100644 index 184ca28..0000000 --- a/api-reference-v1-stable/series/series.gt.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -description: Check if all the value in a series is greater than a value ---- - -# Series.gt - -> danfo.Series.gt(other) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L856)] - -| Parameters | Type | Description | Default | -| ---------- | ----------------------- | ------------------- | ------- | -| other | Series, Array or number | value(s) to compare | | - -**Returns**: Series (boolean element) - -**Example** - -Check if all the values in a series are greater than a value - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [10, 45, 56, 25, 23, 20, 10] -let sf1 = new dfd.Series(data1) - -sf1.gt(20).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ false ║ -╟───┼──────────────────────╢ -║ 1 │ true ║ -╟───┼──────────────────────╢ -║ 2 │ true ║ -╟───┼──────────────────────╢ -║ 3 │ true ║ -╟───┼──────────────────────╢ -║ 4 │ true ║ -╟───┼──────────────────────╢ -║ 5 │ false ║ -╟───┼──────────────────────╢ -║ 6 │ false ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -check if all the values in a series are greater than values in another series. - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [10, 45, 56, 25, 23, 20, 10] -let data2 = [10, 450, 56, 5, 25, 2, 0] -let sf1 = new dfd.Series(data1) -let sf2 = new dfd.Series(data2) - -sf1.gt(sf2).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ false ║ -╟───┼──────────────────────╢ -║ 1 │ false ║ -╟───┼──────────────────────╢ -║ 2 │ false ║ -╟───┼──────────────────────╢ -║ 3 │ true ║ -╟───┼──────────────────────╢ -║ 4 │ false ║ -╟───┼──────────────────────╢ -║ 5 │ true ║ -╟───┼──────────────────────╢ -║ 6 │ true ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.head.md b/api-reference-v1-stable/series/series.head.md deleted file mode 100644 index 2892263..0000000 --- a/api-reference-v1-stable/series/series.head.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -description: Obtain the first n rows for the object based on position. ---- - -# Series.head - -> danfo.Series.head\(rows\) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L76)\] - -| Parameters | Type | Description | Default | -| :--- | :--- | :--- | :--- | -| rows | Int | number of first n values | 5 | - - **Return:** Series - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [1, 2, 3, 4, 5, 620, 30, 40, 39, 89, 78] -let sf1 = new dfd.Series(data1) - -sf1.head().print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```text -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 1 ║ -╟───┼──────────────────────╢ -║ 1 │ 2 ║ -╟───┼──────────────────────╢ -║ 2 │ 3 ║ -╟───┼──────────────────────╢ -║ 3 │ 4 ║ -╟───┼──────────────────────╢ -║ 4 │ 5 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - - - diff --git a/api-reference-v1-stable/series/series.iloc.md b/api-reference-v1-stable/series/series.iloc.md deleted file mode 100644 index ab7d1f3..0000000 --- a/api-reference-v1-stable/series/series.iloc.md +++ /dev/null @@ -1,158 +0,0 @@ -# Series.iloc - -danfo.Series.**iloc**() \[[source](https://github.com/opensource9ja/danfojs/blob/fe56860b0a303d218d60ba71dee6abf594401556/danfojs/src/core/frame.js#L254)] - -| Parameters | Type | Description | Default | -| ---------- | -------------- | ----------------------------------------------------------------------- | ------- | -| rows | Array, String | Array, string slice, index of row positions boolean mask to filter by. | | - -**Returns:** - - **** return **Series** - -## **Examples** - -`.iloc()` is primarily integer position based (from `0` to `length-1` of the axis). - -Allowed inputs are: - -* An integer, e.g. `5`. -* A list or array of integers, e.g. `[4, 3, 0]`. -* A boolean mask. E.g \[ true, false, false ] -* A string slice object with ints, e.g. `"1:7"` - -_**Note:** only **** the start label is included, and the end label is ignored._ - -`.iloc` will raise`IndexError` if a requested indexer is out-of-bounds. - -### **Indexing specific rows by index** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let s = new dfd.Series([12, 34, 2.2, 2, 30, 30, 2.1, 7]) -s.iloc([0,5]).print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 12 ║ -╟───┼──────────────────────╢ -║ 5 │ 30 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### **Index by a slice of row** - -The [**iloc**](../dataframe/danfo.dataframe.iloc.md) function also accepts string slices of the form \[start: end], e.g "\[0: 5]". This will return all values from index positions 0 to 4. - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let s = new dfd.Series([12, 34, 2.2, 2, 30, 30, 2.1, 7]) -s.iloc(["0:5"]).print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 12 ║ -╟───┼──────────────────────╢ -║ 1 │ 34 ║ -╟───┼──────────────────────╢ -║ 2 │ 2.2 ║ -╟───┼──────────────────────╢ -║ 3 │ 2 ║ -╟───┼──────────────────────╢ -║ 4 │ 30 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -By specifying a start index in a slice, all values after that index are returned. - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let s = new dfd.Series([12, 34, 2.2, 2, 30, 30, 2.1, 7]) -s.iloc(["5:"]).print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 5 │ 30 ║ -╟───┼──────────────────────╢ -║ 6 │ 2.1 ║ -╟───┼──────────────────────╢ -║ 7 │ 7 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Slice Series by boolean condition - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let s = new dfd.Series([12, 34, 2.2, 2, 30, 30, 2.1, 7]) -s.iloc(s.gt(20)).print() -``` -{% endtab %} -{% endtabs %} - -``` -╔═══╤════╗ -║ 1 │ 34 ║ -╟───┼────╢ -║ 4 │ 30 ║ -╟───┼────╢ -║ 5 │ 30 ║ -╚═══╧════╝ -``` diff --git a/api-reference-v1-stable/series/series.index.md b/api-reference-v1-stable/series/series.index.md deleted file mode 100644 index 1cc95da..0000000 --- a/api-reference-v1-stable/series/series.index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -description: Obtain the index of a Series ---- - -# Series.index - -> danfo.Series.index \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/generic.js#L234)\] - -**Returns**: Array - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [30.21091, 40.190901, 3.564, 5.0212] -let sf1 = new dfd.Series(data1) - -console.log(sf1.index) -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```text -[ 0, 1, 2, 3 ] -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/series/series.isna.md b/api-reference-v1-stable/series/series.isna.md deleted file mode 100644 index cdf6343..0000000 --- a/api-reference-v1-stable/series/series.isna.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: Detect Missing values ---- - -# Series.isna - -> danfo.Series.**isna**\(\) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L449)\] - -**Parameters**: None - -**Returns**: Series \(Boolean element\) - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [NaN, undefined, "girl", "Man"] -let sf = new dfd.Series(data1) - -sf.isna().print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```text -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ true ║ -╟───┼──────────────────────╢ -║ 1 │ true ║ -╟───┼──────────────────────╢ -║ 2 │ false ║ -╟───┼──────────────────────╢ -║ 3 │ false ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/series/series.le.md b/api-reference-v1-stable/series/series.le.md deleted file mode 100644 index 44006e2..0000000 --- a/api-reference-v1-stable/series/series.le.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -description: Check if all the values in a series is less than or equal to a value ---- - -# Series.le - -> danfo.Series.le(other) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L865)] - -| Parameters | Type | Description | Default | -| ---------- | ----------------------- | ------------------- | ------- | -| other | Series, Array or number | value(s) to compare | | - -**Returns:** Series (Boolean Element) - -**Example** - -Check if all the values in a series is less than or equal to a value - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [10, 45, 56, 25, 23, 20, 10] -let sf1 = new dfd.Series(data1) - -sf1.le(20).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ true ║ -╟───┼──────────────────────╢ -║ 1 │ false ║ -╟───┼──────────────────────╢ -║ 2 │ false ║ -╟───┼──────────────────────╢ -║ 3 │ false ║ -╟───┼──────────────────────╢ -║ 4 │ false ║ -╟───┼──────────────────────╢ -║ 5 │ true ║ -╟───┼──────────────────────╢ -║ 6 │ true ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -check if all the values in a series are less than equal to values in another series. - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [10, 45, 56, 25, 23, 20, 10] -let data2 = [10, 450, 56, 5, 25, 2, 0] -let sf1 = new dfd.Series(data1) -let sf2 = new dfd.Series(data2) - -sf1.le(sf2).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ true ║ -╟───┼──────────────────────╢ -║ 1 │ true ║ -╟───┼──────────────────────╢ -║ 2 │ true ║ -╟───┼──────────────────────╢ -║ 3 │ false ║ -╟───┼──────────────────────╢ -║ 4 │ true ║ -╟───┼──────────────────────╢ -║ 5 │ false ║ -╟───┼──────────────────────╢ -║ 6 │ false ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/series/series.loc.md b/api-reference-v1-stable/series/series.loc.md deleted file mode 100644 index 13772ab..0000000 --- a/api-reference-v1-stable/series/series.loc.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -description: Access a group of rows by label(s) or a boolean array. ---- - -# Series.loc - -danfo.Series.**loc**() \[[source](https://github.com/opensource9ja/danfojs/blob/fe56860b0a303d218d60ba71dee6abf594401556/danfojs/src/core/frame.js#L254)] - -| Parameters | Type | Description | Default | -| ---------- | -------------- | ----------------------------------------------------------------------- | ------- | -| rows | Array, String | Array, string slice, index of row positions boolean mask to filter by. | | - -**Returns:** - - **** return **Series** - -## **Examples** - -`.loc()` is label position based (from `0` to `length-1` of the row axis). - -Allowed inputs are: - -* An integer, e.g. `"r1"`. -* A list or array of integers, e.g. `["a", "b", "d"]`. -* A boolean mask. E.g \[ true, false, false ] -* A string slice object with ints, e.g. `[`'`"a":"d"'], ["1:4"]` - -_**Note:** only **** the start label is included, and the end label is ignored._ - -`.loc` will raise a `ValueEror` if a requested label is not found. - -### **Indexing by specific row index** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -const data = [12, 34, 2.2, 2, 30, 30, 2.1, 7] -const index = ["a", "b", "c", "d", "e", "f", "g", "h"] -let s = new dfd.Series(data, { index }) -s.print() - -s.loc(["a", "g"]).print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═════╗ -║ a │ 12 ║ -╟───┼─────╢ -║ b │ 34 ║ -╟───┼─────╢ -║ c │ 2.2 ║ -╟───┼─────╢ -║ d │ 2 ║ -╟───┼─────╢ -║ e │ 30 ║ -╟───┼─────╢ -║ f │ 30 ║ -╟───┼─────╢ -║ g │ 2.1 ║ -╟───┼─────╢ -║ h │ 7 ║ -╚═══╧═════╝ - -╔═══╤═════╗ -║ a │ 12 ║ -╟───┼─────╢ -║ g │ 2.1 ║ -╚═══╧═════╝ -``` -{% endtab %} -{% endtabs %} - -### **Index by a slice of row** - -The **loc** function also accepts string slices of the form \[start: end], e.g **\[\`"a":"e"\`]**. This will return all values from label positions `a` to `e`. - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -const data = [12, 34, 2.2, 2, 30, 30, 2.1, 7] -const index = ["a", "b", "c", "d", "e", "f", "g", "h"] -let s = new dfd.Series(data, { index }) -s.print() - -s.loc([`"a":"e"`]).print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═════╗ -║ a │ 12 ║ -╟───┼─────╢ -║ b │ 34 ║ -╟───┼─────╢ -║ c │ 2.2 ║ -╟───┼─────╢ -║ d │ 2 ║ -╚═══╧═════╝ -``` -{% endtab %} -{% endtabs %} - -{% hint style="info" %} -Note that when using loc. We expect you to pass labels in the correct format. That is, string labels must be explicitly quoted. For example, the following loc slice will throw an error:\ -`s.loc([a:e]).print()`\ -For the slice above to work, you must quote each slice, e.g:\ -`s.loc(["a":"e"]).print()`\ -\ -_**Inner quotes are not needed for numeric indices!**_ -{% endhint %} - -### By specifying a start index in a slice, all values after that index are returned. - -{% tabs %} -{% tab title="Node" %} -```javascript -const data = [12, 34, 2.2, 2, 30, 30, 2.1, 7] -let s = new dfd.Series(data) - -s.loc([`1:`]).print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═════╗ -║ 1 │ 34 ║ -╟───┼─────╢ -║ 2 │ 2.2 ║ -╟───┼─────╢ -║ 3 │ 2 ║ -╟───┼─────╢ -║ 4 │ 30 ║ -╟───┼─────╢ -║ 5 │ 30 ║ -╟───┼─────╢ -║ 6 │ 2.1 ║ -╟───┼─────╢ -║ 7 │ 7 ║ -╚═══╧═════╝ - -``` -{% endtab %} -{% endtabs %} - -### Slice Series by boolean condition - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - - -let s = new dfd.Series([12, 34, 2.2, 2, 30, 30, 2.1, 7]) -s.loc(s.gt(20)).print() -``` -{% endtab %} -{% endtabs %} - -``` -╔═══╤════╗ -║ 1 │ 34 ║ -╟───┼────╢ -║ 4 │ 30 ║ -╟───┼────╢ -║ 5 │ 30 ║ -╚═══╧════╝ -``` diff --git a/api-reference-v1-stable/series/series.lt.md b/api-reference-v1-stable/series/series.lt.md deleted file mode 100644 index 7af18bc..0000000 --- a/api-reference-v1-stable/series/series.lt.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -description: Check if all values in a Series are less than a value. ---- - -# Series.lt - -> danfo.Series.lt(other) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L847)] - -| Parameters | Type | Description | Default | -| ---------- | ----------------------- | ------------------- | ------- | -| other | Series, Array or number | value(s) to compare | | - -**Returns**: Series (boolean element) - -**Example** - -Check if all the values in a series are less than a value - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [10, 45, 56, 25, 23, 20, 10] -let sf1 = new dfd.Series(data1) - -sf1.lt(20).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ false ║ -╟───┼──────────────────────╢ -║ 1 │ true ║ -╟───┼──────────────────────╢ -║ 2 │ true ║ -╟───┼──────────────────────╢ -║ 3 │ true ║ -╟───┼──────────────────────╢ -║ 4 │ true ║ -╟───┼──────────────────────╢ -║ 5 │ false ║ -╟───┼──────────────────────╢ -║ 6 │ false ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -check if all the values in a series are less than values in another series. - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [10, 45, 56, 25, 23, 20, 10] -let data2 = [10, 450, 56, 5, 25, 2, 0] -let sf1 = new dfd.Series(data1) -let sf2 = new dfd.Series(data2) - -sf1.lt(sf2).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ false ║ -╟───┼──────────────────────╢ -║ 1 │ true ║ -╟───┼──────────────────────╢ -║ 2 │ false ║ -╟───┼──────────────────────╢ -║ 3 │ false ║ -╟───┼──────────────────────╢ -║ 4 │ true ║ -╟───┼──────────────────────╢ -║ 5 │ false ║ -╟───┼──────────────────────╢ -║ 6 │ false ║ -╚═══╧══════════════════════╝ - -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.map.md b/api-reference-v1-stable/series/series.map.md deleted file mode 100644 index 0e0850a..0000000 --- a/api-reference-v1-stable/series/series.map.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -description: Map the value of a series to a function or Object ---- - -# Series.map - -> danfo.series.**map**(callable) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L685)] - -| Parameter | Type | Description | Default | -| --------- | ------------------ | ---------------------------------------------------------------------------------------------- | ------------------------------------- | -| callable | Function or Object | A function or object({}) | | -| options | Object | inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false |{
inplace: false
}
| - -**Example** - -Mapping the element in a Series words in an Object - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let sf = new dfd.Series([1, 2, 3, 4]) -let map = { 1: "ok", 2: "okie", 3: "frit", 4: "gop" } -sf.map(map).print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ ok ║ -╟───┼──────────────────────╢ -║ 1 │ okie ║ -╟───┼──────────────────────╢ -║ 2 │ frit ║ -╟───┼──────────────────────╢ -║ 3 │ gop ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -Mapping values in a Series to a representation using functions. - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let sf = new dfd.Series([1,2,3,4]) - -sf.map((x)=>{ - return `I have ${x} cat(s)` -}).print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ I have 1 cat(s) ║ -╟───┼──────────────────────╢ -║ 1 │ I have 2 cat(s) ║ -╟───┼──────────────────────╢ -║ 2 │ I have 3 cat(s) ║ -╟───┼──────────────────────╢ -║ 3 │ I have 4 cat(s) ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.max.md b/api-reference-v1-stable/series/series.max.md deleted file mode 100644 index 4f7193a..0000000 --- a/api-reference-v1-stable/series/series.max.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -description: Obtain the maximum value in a Series ---- - -# Series.max - -> danfo.Series.max() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L317)] - -**Parameter:** None - -**Return:** Number - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [20, 30, 1, 2, 4, 57, 89, 0, 4] -let sf1 = new dfd.Series(data1) - -console.log(sf1.max()) -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -89 -``` -{% endtab %} -{% endtabs %} - -**** diff --git a/api-reference-v1-stable/series/series.maximum.md b/api-reference-v1-stable/series/series.maximum.md deleted file mode 100644 index afc5a48..0000000 --- a/api-reference-v1-stable/series/series.maximum.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -description: Obtain the maximum number between two series ---- - -# Series.maximum - -> danfo.Series.maximum\(other\) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L363)\] - -| Parameters | Type | Description | Default | -| :--- | :--- | :--- | :--- | -| other | Series | series to match | | - -**Return:** {Series} - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [30, 40, 3, 5] -let data2 = [10, 41, 2, 0] -let sf1 = new dfd.Series(data1) -let sf2 = new dfd.Series(data2) -sf1.maximum(sf2).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="output" %} -```text -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 30 ║ -╟───┼──────────────────────╢ -║ 1 │ 41 ║ -╟───┼──────────────────────╢ -║ 2 │ 3 ║ -╟───┼──────────────────────╢ -║ 3 │ 5 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - - - diff --git a/api-reference-v1-stable/series/series.mean.md b/api-reference-v1-stable/series/series.mean.md deleted file mode 100644 index 17d97e6..0000000 --- a/api-reference-v1-stable/series/series.mean.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -description: Obtain the mean of a series ---- - -# Series.mean - -> danfo.Series.mean() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L253)] - -**Parameter:** None - -**Return:** Number - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [20, 30, 1, 2, 4, 57, 89, 0, 4] -let sf1 = new dfd.Series(data1) - -console.log(sf1.mean()) -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -23.000001907348633 -``` -{% endtab %} -{% endtabs %} - -**** diff --git a/api-reference-v1-stable/series/series.median.md b/api-reference-v1-stable/series/series.median.md deleted file mode 100644 index d1cde75..0000000 --- a/api-reference-v1-stable/series/series.median.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -description: Obtain the median of a series ---- - -# Series.median - -> danfo.Series.median() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L274)] - -**Parameter:** None - -**Return:** Number - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [20, 30, 1, 2, 4, 57, 89, 0, 4] -let sf1 = new dfd.Series(data1) - -console.log(sf1.median()) -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -4 -``` -{% endtab %} -{% endtabs %} - -**** diff --git a/api-reference-v1-stable/series/series.min.md b/api-reference-v1-stable/series/series.min.md deleted file mode 100644 index 6e11a67..0000000 --- a/api-reference-v1-stable/series/series.min.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -description: Obtain the minimum value in a series ---- - -# Series.min - -> danfo.Series.min() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L303)] - -**Parameter:** None - -**Return:** Number - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [20, 30, 1, 2, 4, 57, 89, 0, 4] -let sf1 = new dfd.Series(data1) - -console.log(sf1.min()) -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -0 -``` -{% endtab %} -{% endtabs %} - -**** diff --git a/api-reference-v1-stable/series/series.minimum.md b/api-reference-v1-stable/series/series.minimum.md deleted file mode 100644 index a06ba69..0000000 --- a/api-reference-v1-stable/series/series.minimum.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -description: Obtain the minimum value between two series (element wise) ---- - -# Series.minimum - -> danfo.Series.minimum\(other\) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L383)\] - -| Parameters | Type | Description | Default | -| :--- | :--- | :--- | :--- | -| other | Series | series to match | | - -**Return:** {Series} - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [30, 40, 3, 5] -let data2 = [10, 41, 2, 0] -let sf1 = new dfd.Series(data1) -let sf2 = new dfd.Series(data2) -sf1.minimum(sf2).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="output" %} -```text -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 10 ║ -╟───┼──────────────────────╢ -║ 1 │ 40 ║ -╟───┼──────────────────────╢ -║ 2 │ 2 ║ -╟───┼──────────────────────╢ -║ 3 │ 0 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/series/series.mod.md b/api-reference-v1-stable/series/series.mod.md deleted file mode 100644 index fdf0555..0000000 --- a/api-reference-v1-stable/series/series.mod.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -description: Return Modulo of series and other, element-wise (binary operator mod). ---- - -# Series.mod - -> danfo.Series.mod(other, options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L235)] - -| Parameters | Type | Description | Default | -| ---------- | ------------------ | ---------------------------------------------------------------------------------------------- | ------------------------------------- | -| other | Series\|int\|float | values | | -| options | Object | inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false |{
inplace: false
}
| - -**Return:** Series - -**Example** - -Modulus with values of another series - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [2, 30, 4, 5] -let data2 = [1.1, 2.2, 3.3, 2.4] -let sf1 = new dfd.Series(data1) -let sf2 = new dfd.Series(data2) -sf1.mod(sf2).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 0.8999999761581421 ║ -╟───┼──────────────────────╢ -║ 1 │ 1.3999993801116943 ║ -╟───┼──────────────────────╢ -║ 2 │ 0.7000000476837158 ║ -╟───┼──────────────────────╢ -║ 3 │ 0.19999980926513672 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -Modulo with a value - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [1, 2, 3, 4, 5] -let sf1 = new dfd.Series(data1) - -sf1.mod(2).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 1 ║ -╟───┼──────────────────────╢ -║ 1 │ 0 ║ -╟───┼──────────────────────╢ -║ 2 │ 1 ║ -╟───┼──────────────────────╢ -║ 3 │ 0 ║ -╟───┼──────────────────────╢ -║ 4 │ 1 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.mode.md b/api-reference-v1-stable/series/series.mode.md deleted file mode 100644 index 6077686..0000000 --- a/api-reference-v1-stable/series/series.mode.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -description: Obtain the center value in a series ---- - -# Series.mode - -> danfo.Series.min() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L303)] - -**Parameter:** None - -**Return:** Number - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [20, 30, 1, 2, 4, 57, 89, 0, 4] -let sf1 = new dfd.Series(data1) - -console.log(sf1.mode()) -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -[ 4 ] -``` -{% endtab %} -{% endtabs %} - -**** diff --git a/api-reference-v1-stable/series/series.mul.md b/api-reference-v1-stable/series/series.mul.md deleted file mode 100644 index d5d33de..0000000 --- a/api-reference-v1-stable/series/series.mul.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -description: Return Multiplication of series and other, element-wise (binary operator mul). ---- - -# Series.mul - -> danfo.Series.mul(other, options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L168)] - -| Parameters | Type | Description | Default | -| ---------- | ------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------- | -| other | Series\|int\| | values | | -| options | Object | inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false |{
inplace: false
}
| - -**Return:** Series - -**Example** - -multiplication with values of another series - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [30, 40, 3, 5] -let data2 = [1, 2, 3, 4] -let sf1 = new dfd.Series(data1) -let sf2 = new dfd.Series(data2) -sf1.mul(sf2).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 30 ║ -╟───┼──────────────────────╢ -║ 1 │ 80 ║ -╟───┼──────────────────────╢ -║ 2 │ 9 ║ -╟───┼──────────────────────╢ -║ 3 │ 20 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -multiply with a value - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [1, 2, 3, 4, 5] -let sf1 = new dfd.Series(data1) - -sf1.mul(2).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 2 ║ -╟───┼──────────────────────╢ -║ 1 │ 4 ║ -╟───┼──────────────────────╢ -║ 2 │ 6 ║ -╟───┼──────────────────────╢ -║ 3 │ 8 ║ -╟───┼──────────────────────╢ -║ 4 │ 10 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/series/series.ndim.md b/api-reference-v1-stable/series/series.ndim.md deleted file mode 100644 index 8623e80..0000000 --- a/api-reference-v1-stable/series/series.ndim.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -description: Obtain the dimension of a series ---- - -# Series.ndim - -> danfo.Series.ndim \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/generic.js#L209)] - -**Parameters:** None - -**Returns:** int - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [30.21091, 40.190901, 3.564, 5.0212] -let sf1 = new dfd.Series(data1) - -console.log(sf1.ndim) -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -1 -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.ne.md b/api-reference-v1-stable/series/series.ne.md deleted file mode 100644 index 16cf1dc..0000000 --- a/api-reference-v1-stable/series/series.ne.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -description: Check if all values in a series is not equal to a value(s) ---- - -# Series.ne - -> danfo.Series.ne(other) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L883)] - -| Parameters | Type | Description | Default | -| ---------- | ----------------------- | ----------------- | ------- | -| other | Series, Array or number | value to compare | | - -**Returns**: Series (Boolean element) - -**Example** - -Compare all the values in a series to that in another series - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [10, 45, 56, 25, 23, 20, 10] -let data2 = [10, 450, 56, 5, 25, 2, 0] -let sf1 = new dfd.Series(data1) -let sf2 = new dfd.Series(data2) - -sf1.ne(sf2).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ false ║ -╟───┼──────────────────────╢ -║ 1 │ true ║ -╟───┼──────────────────────╢ -║ 2 │ false ║ -╟───┼──────────────────────╢ -║ 3 │ true ║ -╟───┼──────────────────────╢ -║ 4 │ true ║ -╟───┼──────────────────────╢ -║ 5 │ true ║ -╟───┼──────────────────────╢ -║ 6 │ true ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -Compare all the values in a Series to a value. - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [10, 45, 56, 25, 23, 20, 10] -let sf1 = new dfd.Series(data1) - -sf1.ne(10).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ false ║ -╟───┼──────────────────────╢ -║ 1 │ true ║ -╟───┼──────────────────────╢ -║ 2 │ true ║ -╟───┼──────────────────────╢ -║ 3 │ true ║ -╟───┼──────────────────────╢ -║ 4 │ true ║ -╟───┼──────────────────────╢ -║ 5 │ true ║ -╟───┼──────────────────────╢ -║ 6 │ false ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.nunique.md b/api-reference-v1-stable/series/series.nunique.md deleted file mode 100644 index 092a2eb..0000000 --- a/api-reference-v1-stable/series/series.nunique.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -description: Returns the number of unique values in a series ---- - -# Series.nunique - -> danfo.Series.**nunique**() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L750)] - -**Parameters**: None - -**Returns:** int - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [1, 2, 3, 4, 5, 6, 7, 8, 1, 1, 22, 8, 5, 5, 5] -let sf = new dfd.Series(data1) - -console.log(sf.nunique()) -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Ouptut" %} -``` -9 -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.or.md b/api-reference-v1-stable/series/series.or.md deleted file mode 100644 index 948c61d..0000000 --- a/api-reference-v1-stable/series/series.or.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -description: >- - Returns the logical OR between Series and other. Supports element wise - operations and broadcasting. ---- - -# Series.or - -> danfo.Series.**or**\(other\) \[[source](https://github.com/opensource9ja/danfojs/blob/e25010c26d9c423412613d820015a48ad03d5c6d/danfojs-node/src/core/series.js#L1243)\] - -| Parameters | Type | Description | Default | -| :--- | :--- | :--- | :--- | -| other | Series, Scalar, Array of Scalars | Data to compare with | | - - **Return:** Series - -### **Logical OR between two Series object** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [false, false, false, true, false, false, true]; -let data2 = [false, false, false, false, false, false, true]; - -let sf = new dfd.Series(data1); -let sf2 = new dfd.Series(data2); -let res = sf.or(sf2) -res.print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```text -╔═══╤═══════╗ -║ 0 │ false ║ -╟───┼───────╢ -║ 1 │ false ║ -╟───┼───────╢ -║ 2 │ false ║ -╟───┼───────╢ -║ 3 │ true ║ -╟───┼───────╢ -║ 4 │ false ║ -╟───┼───────╢ -║ 5 │ false ║ -╟───┼───────╢ -║ 6 │ true ║ -╚═══╧═══════╝ -``` -{% endtab %} -{% endtabs %} - -### **Logical OR between Series and Array of the same length** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [false, false, false, true, false, false, true]; -let data2 = [false, false, false, false, false, false, true]; - -let sf = new dfd.Series(data1); -let res = sf.or(data2) -res.print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```text -╔═══╤═══════╗ -║ 0 │ false ║ -╟───┼───────╢ -║ 1 │ false ║ -╟───┼───────╢ -║ 2 │ false ║ -╟───┼───────╢ -║ 3 │ true ║ -╟───┼───────╢ -║ 4 │ false ║ -╟───┼───────╢ -║ 5 │ false ║ -╟───┼───────╢ -║ 6 │ true ║ -╚═══╧═══════╝ -``` -{% endtab %} -{% endtabs %} - -### **Logical OR between a Series and single value with broadcasting** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") -let data1 = [false, false, false, true, false, false, true]; - -let sf = new dfd.Series(data1); -let res = sf.or(false) -res.print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```text -╔═══╤═══════╗ -║ 0 │ false ║ -╟───┼───────╢ -║ 1 │ false ║ -╟───┼───────╢ -║ 2 │ false ║ -╟───┼───────╢ -║ 3 │ true ║ -╟───┼───────╢ -║ 4 │ false ║ -╟───┼───────╢ -║ 5 │ false ║ -╟───┼───────╢ -║ 6 │ true ║ -╚═══╧═══════╝ -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/series/series.pow.md b/api-reference-v1-stable/series/series.pow.md deleted file mode 100644 index 2fbe542..0000000 --- a/api-reference-v1-stable/series/series.pow.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -description: >- - Return Exponential power of series and other, element-wise (binary operator - pow). ---- - -# Series.pow - -> danfo.Series.pow(other, options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L216)] - -| Parameters | Type | Description | Default | -| ---------- | ------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------- | -| other | Series\|int\| | values | | -| options | Object | inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false |{
inplace: false
}
| - -**Return:** Series - -**Example** - -Exponential power with values of another series - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [2, 3, 4, 5] -let data2 = [1, 2, 3, 0] -let sf1 = new dfd.Series(data1) -let sf2 = new dfd.Series(data2) -sf1.pow(sf2).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 2 ║ -╟───┼──────────────────────╢ -║ 1 │ 9 ║ -╟───┼──────────────────────╢ -║ 2 │ 64 ║ -╟───┼──────────────────────╢ -║ 3 │ 1 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -Exponential value with a value - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [1, 2, 3, 4, 5] -let sf1 = new dfd.Series(data1) - -sf1.pow(2).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 1 ║ -╟───┼──────────────────────╢ -║ 1 │ 4 ║ -╟───┼──────────────────────╢ -║ 2 │ 9 ║ -╟───┼──────────────────────╢ -║ 3 │ 16 ║ -╟───┼──────────────────────╢ -║ 4 │ 25 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.replace.md b/api-reference-v1-stable/series/series.replace.md deleted file mode 100644 index 8a1f48b..0000000 --- a/api-reference-v1-stable/series/series.replace.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -description: Replace values given in replace param with value ---- - -# Series.replace - -> danfo.Series.**replace**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L892)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | -| options | Object |oldValue: The value you want to replace
newValue: The new value you want to replace the old value with
inplace: Boolean indicating whether to perform the operation inplace or not
|{
inplace: false
}
| - -**Returns**: Series - -**Examples** - -### Replace a value in a series and return a new series - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [10, 45, 56, 25, 23, 20, 10] -let sf = new dfd.Series(data1) -let sf_rep = sf.replace({ oldValue: 10, newValue: -50 }) - -sf_rep.print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═════╗ -║ 0 │ -50 ║ -╟───┼─────╢ -║ 1 │ 45 ║ -╟───┼─────╢ -║ 2 │ 56 ║ -╟───┼─────╢ -║ 3 │ 25 ║ -╟───┼─────╢ -║ 4 │ 23 ║ -╟───┼─────╢ -║ 5 │ 20 ║ -╟───┼─────╢ -║ 6 │ -50 ║ -╚═══╧═════╝ - -``` -{% endtab %} -{% endtabs %} - -### Replace a value in-place - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [10, 45, 56, 25, 23, 20, 10] -let sf = new dfd.Series(data1) -sf.replace({ oldValue: 10, newValue: -50, inplace: true}) - -sf.print() -``` -{% endtab %} -{% endtabs %} - -``` -╔═══╤═════╗ -║ 0 │ -50 ║ -╟───┼─────╢ -║ 1 │ 45 ║ -╟───┼─────╢ -║ 2 │ 56 ║ -╟───┼─────╢ -║ 3 │ 25 ║ -╟───┼─────╢ -║ 4 │ 23 ║ -╟───┼─────╢ -║ 5 │ 20 ║ -╟───┼─────╢ -║ 6 │ -50 ║ -╚═══╧═════╝ - -``` diff --git a/api-reference-v1-stable/series/series.reset_index.md b/api-reference-v1-stable/series/series.reset_index.md deleted file mode 100644 index c51497a..0000000 --- a/api-reference-v1-stable/series/series.reset_index.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -description: Reset the index of a series. ---- - -# Series.reset\_index - -> danfo.series.reset\_index(options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L614)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------------------------------------------- | ---------------- | -| options | Object | **inplace:** Boolean indicating whether to perform the operation inplace or not. Defaults to false | { inplace:false} | - -**Returns :** Series - -`reset_index` is useful when the index needs to be treated as a column, or when the index is meaningless and needs to be reset to default, before another operation. - -### **Reset index to default values** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") -let data = [20, 30, 40] -let sf = new dfd.Series(data, { index: ["a", "b", "c"] }) -sf.print() - -let sf_reset = sf.reset_index() -sf_reset.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤════╗ -║ a │ 20 ║ -╟───┼────╢ -║ b │ 30 ║ -╟───┼────╢ -║ c │ 40 ║ -╚═══╧════╝ - -╔═══╤════╗ -║ 0 │ 20 ║ -╟───┼────╢ -║ 1 │ 30 ║ -╟───┼────╢ -║ 2 │ 40 ║ -╚═══╧════╝ -``` -{% endtab %} -{% endtabs %} - -### Reset index to new values in-place - -{% tabs %} -{% tab title="Node" %} -```javascript -let data = [1, 2, 3, 4, 5, 6] -let sf = new dfd.Series(data, { index: ['a', 'b', 'c', 'd', 'e', 'f'] }) -sf.print() - -sf.reset_index({ inplace: true }) -sf.print() - -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══╗ -║ a │ 1 ║ -╟───┼───╢ -║ b │ 2 ║ -╟───┼───╢ -║ c │ 3 ║ -╟───┼───╢ -║ d │ 4 ║ -╟───┼───╢ -║ e │ 5 ║ -╟───┼───╢ -║ f │ 6 ║ -╚═══╧═══╝ - -╔═══╤═══╗ -║ 0 │ 1 ║ -╟───┼───╢ -║ 1 │ 2 ║ -╟───┼───╢ -║ 2 │ 3 ║ -╟───┼───╢ -║ 3 │ 4 ║ -╟───┼───╢ -║ 4 │ 5 ║ -╟───┼───╢ -║ 5 │ 6 ║ -╚═══╧═══╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.round.md b/api-reference-v1-stable/series/series.round.md deleted file mode 100644 index b6f0d82..0000000 --- a/api-reference-v1-stable/series/series.round.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -description: round off floating values in series ---- - -# Series.round - -> danfo.Series.round(dp, options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L404)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ---------------------------------------------------------------------------------------------- | ------------------------------------- | -| dp | int | decimal place to round off to | | -| options | Object | inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false |{
inplace: false
}
| - -**Returns:** Series - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [30.21091, 40.190901, 3.564, 5.0212] -let sf1 = new dfd.Series(data1) - -sf1.round(2).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 30.21 ║ -╟───┼──────────────────────╢ -║ 1 │ 40.19 ║ -╟───┼──────────────────────╢ -║ 2 │ 3.56 ║ -╟───┼──────────────────────╢ -║ 3 │ 5.02 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/series/series.sample.md b/api-reference-v1-stable/series/series.sample.md deleted file mode 100644 index a28298d..0000000 --- a/api-reference-v1-stable/series/series.sample.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -description: Return a random sample of items from an axis of object. ---- - -# Series.sample - -> danfo.Series.sample(num) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L98)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | -| num | Int | The number of rows to return. | | -| options | Object | **seed**: An integer specifying the random seed that will be used to create the distribution. Ensures reproducibility of generated samples. |{
seed: 1
}
| - -**Returns:** - - **** return **{Promies} resolves to Series** - -**Example** - -```javascript -const dfd = require("danfojs-node") - -async function load_data() { - let data1 = [1, 2, 3, 4, 5, 620, 30, 40, 39, 89, 78]; - let sf1 = new dfd.Series(data1); - let sample = await sf1.sample(5) - sample.print() - -} -load_data() -``` - -{% tabs %} -{% tab title="Output" %} -```javascript -╔═══╤════╗ -║ 2 │ 3 ║ -╟───┼────╢ -║ 4 │ 5 ║ -╟───┼────╢ -║ 0 │ 1 ║ -╟───┼────╢ -║ 7 │ 40 ║ -╟───┼────╢ -║ 6 │ 30 ║ -╚═══╧════╝ -``` -{% endtab %} -{% endtabs %} - -### Specify a seed when sampling - -```javascript -const dfd = require("danfojs-node") - -async function load_data() { - let data1 = [1, 2, 3, 4, 5, 620, 30, 40, 39, 89, 78]; - let sf1 = new dfd.Series(data1); - let sample = await sf1.sample(5, { seed: 2 }) - sample.print() - -} -load_data() - -``` diff --git a/api-reference-v1-stable/series/series.set_index.md b/api-reference-v1-stable/series/series.set_index.md deleted file mode 100644 index 3de352f..0000000 --- a/api-reference-v1-stable/series/series.set_index.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -description: Assign new Index to Series ---- - -# Series.set\_index - -> danfo.series.**set\_index(**options**)** \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L635)] - -| Parameter | Type | Description | Default | -| --------- | ------ | ---------------------------------------------------------------------------------------------- | ------------------------------------- | -| index | Array | new index values | | -| options | Object | inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false |{
inplace: false
}
| - -**Returns:** Series - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") -let data = [{ alpha: "A", count: 1 }, { alpha: "B", count: 2 }, { alpha: "C", count: 3 }] -let sf = new dfd.Series(data) -sf.print() - -let sf_new = sf.set_index({ "index": ["one", "two", "three"] }) -sf_new.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═════════════════════════╗ -║ 0 │ {"alpha":"A","count":1} ║ -╟───┼─────────────────────────╢ -║ 1 │ {"alpha":"B","count":2} ║ -╟───┼─────────────────────────╢ -║ 2 │ {"alpha":"C","count":3} ║ -╚═══╧═════════════════════════╝ - -╔═══════╤═════════════════════════╗ -║ one │ {"alpha":"A","count":1} ║ -╟───────┼─────────────────────────╢ -║ two │ {"alpha":"B","count":2} ║ -╟───────┼─────────────────────────╢ -║ three │ {"alpha":"C","count":3} ║ -╚═══════╧═════════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = ["Humans","Life","Meaning","Fact","Truth"] -let sf = new dfd.Series(data) -let sf_new = sf.set_index({ "index": ["H", "L", "M","F","T"] }) -sf_new.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ H │ Humans ║ -╟───┼──────────────────────╢ -║ L │ Life ║ -╟───┼──────────────────────╢ -║ M │ Meaning ║ -╟───┼──────────────────────╢ -║ F │ Fact ║ -╟───┼──────────────────────╢ -║ T │ Truth ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -### Set index in-place - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs") - -let data = [1, 2, 3, 4, 5, 6] -let sf = new dfd.Series(data) -sf.set_index({ index: ["one", "two", "three", "four", "five", "six"], inplace: true }) -sf.print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══════╤═══╗ -║ one │ 1 ║ -╟───────┼───╢ -║ two │ 2 ║ -╟───────┼───╢ -║ three │ 3 ║ -╟───────┼───╢ -║ four │ 4 ║ -╟───────┼───╢ -║ five │ 5 ║ -╟───────┼───╢ -║ six │ 6 ║ -╚═══════╧═══╝ - -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.shape.md b/api-reference-v1-stable/series/series.shape.md deleted file mode 100644 index 9eb5031..0000000 --- a/api-reference-v1-stable/series/series.shape.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -description: Obtain the shape of a Series ---- - -# Series.shape - -> danfo.Series.shape \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/generic.js#L266)\] - -**Parameters**: None - -**Returns**: Array \[int, int\] - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [30.21091, 40.190901, 3.564, 5.0212] -let sf1 = new dfd.Series(data1) - -console.log(sf1.shape) -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```text -[ 4, 1 ] -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/series/series.size.md b/api-reference-v1-stable/series/series.size.md deleted file mode 100644 index 9665b65..0000000 --- a/api-reference-v1-stable/series/series.size.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -description: Obtain the size of a series ---- - -# Series.size - -> danfo.Series.size \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/generic.js#L305)\] - -**Parameters**: None - -**Returns:** int - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [30.21091, 40.190901, 3.564, 5.0212] -let sf1 = new dfd.Series(data1) - -console.log(sf1.size) -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```text -4 -``` -{% endtab %} -{% endtabs %} - - - diff --git a/api-reference-v1-stable/series/series.sort_values.md b/api-reference-v1-stable/series/series.sort_values.md deleted file mode 100644 index 5c7e5fa..0000000 --- a/api-reference-v1-stable/series/series.sort_values.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -description: Sorts a Series in ascending or descending order ---- - -# Series.sort_values - -> danfo.Series.sort_values(options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L511)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | -| options | Object |inplace: Boolean indicating whether to perform the operation in-place or not. Defaults to false
ascending: Whether to return sorted values in ascending order or not. Defaults to true
|{
ascending: true,
inplace: false
}
| - - **Return:** Series - -### Sort values in a Series - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [20, 30, 1, 2, 4, 57, 89, 0, 4] -let sf1 = new dfd.Series(data1) -let sf2 = sf1.sort_values() - -sf2.print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤════╗ -║ 7 │ 0 ║ -╟───┼────╢ -║ 2 │ 1 ║ -╟───┼────╢ -║ 3 │ 2 ║ -╟───┼────╢ -║ 8 │ 4 ║ -╟───┼────╢ -║ 4 │ 4 ║ -╟───┼────╢ -║ 0 │ 20 ║ -╟───┼────╢ -║ 1 │ 30 ║ -╟───┼────╢ -║ 5 │ 57 ║ -╟───┼────╢ -║ 6 │ 89 ║ -╚═══╧════╝ -``` -{% endtab %} -{% endtabs %} - -### Sort Series in-place - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [20, 30, 1, 2, 4, 57, 89, 0, 4] -let sf1 = new dfd.Series(data1) -sf1.sort_values({ inplace: true }) - -sf1.print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤════╗ -║ 7 │ 0 ║ -╟───┼────╢ -║ 2 │ 1 ║ -╟───┼────╢ -║ 3 │ 2 ║ -╟───┼────╢ -║ 8 │ 4 ║ -╟───┼────╢ -║ 4 │ 4 ║ -╟───┼────╢ -║ 0 │ 20 ║ -╟───┼────╢ -║ 1 │ 30 ║ -╟───┼────╢ -║ 5 │ 57 ║ -╟───┼────╢ -║ 6 │ 89 ║ -╚═══╧════╝ - -``` -{% endtab %} -{% endtabs %} - -Sort Series values in descending order - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [20, 30, 1, 2, 4, 57, 89, 0, 4] -let sf1 = new dfd.Series(data1) -sf1.sort_values({ "ascending": false, "inplace": true }) - -sf1.print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤════╗ -║ 6 │ 89 ║ -╟───┼────╢ -║ 5 │ 57 ║ -╟───┼────╢ -║ 1 │ 30 ║ -╟───┼────╢ -║ 0 │ 20 ║ -╟───┼────╢ -║ 4 │ 4 ║ -╟───┼────╢ -║ 8 │ 4 ║ -╟───┼────╢ -║ 3 │ 2 ║ -╟───┼────╢ -║ 2 │ 1 ║ -╟───┼────╢ -║ 7 │ 0 ║ -╚═══╧════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.std.md b/api-reference-v1-stable/series/series.std.md deleted file mode 100644 index aa05018..0000000 --- a/api-reference-v1-stable/series/series.std.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -description: Obtain the standard deviation for a series ---- - -# Series.std - -> danfo.Series.std() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L422)] - -**Parameter:** None - -**Return:** Number - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [20, 30, 1, 2, 4, 57, 89, 0, 4] -let sf1 = new dfd.Series(data1) - -console.log(sf1.std()) -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -31.11671576500322 -``` -{% endtab %} -{% endtabs %} - - **** - diff --git a/api-reference-v1-stable/series/series.str.capitalize.md b/api-reference-v1-stable/series/series.str.capitalize.md deleted file mode 100644 index aea9e91..0000000 --- a/api-reference-v1-stable/series/series.str.capitalize.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -description: Capitalize the first character of each string ---- - -# Series.str.capitalize - -> danfo.Series.str.**capitalize**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/strings.js#L46)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------- | ------------------------------------------------------ | -| options | Object | **inplace**: Whether to perform the operation in-place or not. |{
inplace: false
}
| - -**Returns**: Series (String element) - -**Example** - -Convert the first character of a string to capital letter - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = ['lower boy', 'capitals', 'sentence', 'swApCaSe'] -let sf = new dfd.Series(data) -sf.str.capitalize().print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ Lower boy ║ -╟───┼──────────────────────╢ -║ 1 │ Capitals ║ -╟───┼──────────────────────╢ -║ 2 │ Sentence ║ -╟───┼──────────────────────╢ -║ 3 │ Swapcase ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.str.charat.md b/api-reference-v1-stable/series/series.str.charat.md deleted file mode 100644 index 931bb48..0000000 --- a/api-reference-v1-stable/series/series.str.charat.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -description: Obtain the character at the specified index (position) ---- - -# Series.str.charAt - -> danfo.Series.str.**charAt**(index) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/strings.js#L64)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------- | ------------------------------------------------------ | -| index | int | the index at which to obtain the character | 0 | -| options | Object | **inplace**: Whether to perform the operation in-place or not. |{
inplace: false
}
| - -**Returns**: Series (Character element) - -**Example** - -Obtain the character at index 2 of all string elements in the series. - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = ['lower boy', 'CAPITALS', 'sentence', 'SwApCaSe'] -let sf = new dfd.Series(data) -sf.str.charAt(2).print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ w ║ -╟───┼──────────────────────╢ -║ 1 │ P ║ -╟───┼──────────────────────╢ -║ 2 │ n ║ -╟───┼──────────────────────╢ -║ 3 │ A ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.str.concat.md b/api-reference-v1-stable/series/series.str.concat.md deleted file mode 100644 index e3abe54..0000000 --- a/api-reference-v1-stable/series/series.str.concat.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -description: Joins two or more strings/arrays ---- - -# Series.str.concat - -> danfo.Series.str.**concat**(other, position, options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/strings.js#L80)] - -| Parameters | Type | Description | Default | -| ---------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | -| other | string or Array | string or list of strings to add to each string element of the series | "" | -| position | Int | The position to add the **other** (string or array) is either 0 or 1. 0 is to add the other at the beginning of each of the string element, and 1 is to add to the end of the string element | 1 | -| options | Object | **inplace**: Whether to perform the operation in-place or not. |{
inplace: false
}
| - -**Returns:** Series (String element) - -**Examples** - -Add the strings from an Array to the start of each of the String element in Series - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = ['lower boy', 'CAPITALS', 'sentence', 'SwApCaSe'] -let data2 = ['XX', 'YY', 'BB', '01'] -let sf = new dfd.Series(data) -sf.str.concat(data2,0).print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ XXlower boy ║ -╟───┼──────────────────────╢ -║ 1 │ YYCAPITALS ║ -╟───┼──────────────────────╢ -║ 2 │ BBsentence ║ -╟───┼──────────────────────╢ -║ 3 │ 01SwApCaSe ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -Add the strings from an Array to the end of each of the String element in Series - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = ['lower boy', 'CAPITALS', 'sentence', 'SwApCaSe'] -let data2 = ['XX', 'YY', 'BB', '01'] -let sf = new dfd.Series(data) -sf.str.concat(data2,1).print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ lower boyXX ║ -╟───┼──────────────────────╢ -║ 1 │ CAPITALSYY ║ -╟───┼──────────────────────╢ -║ 2 │ sentenceBB ║ -╟───┼──────────────────────╢ -║ 3 │ SwApCaSe01 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -Add a string to the start of each string element in a Series - -{% tabs %} -{% tab title="Output" %} -```javascript -const dfd = require("danfojs-node") - -let data = ['lower boy', 'CAPITALS', 'sentence', 'SwApCaSe'] -let data2 = ['XX', 'YY', 'BB', '01'] -let sf = new dfd.Series(data) -sf.str.concat("pre",0).print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ prelower boy ║ -╟───┼──────────────────────╢ -║ 1 │ preCAPITALS ║ -╟───┼──────────────────────╢ -║ 2 │ presentence ║ -╟───┼──────────────────────╢ -║ 3 │ preSwApCaSe ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -Add a string to the end of each string element in a series - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = ['lower boy', 'CAPITALS', 'sentence', 'SwApCaSe'] -let data2 = ['XX', 'YY', 'BB', '01'] -let sf = new dfd.Series(data) -sf.str.concat("post",1).print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ lower boypost ║ -╟───┼──────────────────────╢ -║ 1 │ CAPITALSpost ║ -╟───┼──────────────────────╢ -║ 2 │ sentencepost ║ -╟───┼──────────────────────╢ -║ 3 │ SwApCaSepost ║ -╚═══╧══════════════════════╝ -``` diff --git a/api-reference-v1-stable/series/series.str.endswith.md b/api-reference-v1-stable/series/series.str.endswith.md deleted file mode 100644 index 2fb44cc..0000000 --- a/api-reference-v1-stable/series/series.str.endswith.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -description: Checks whether a string ends with specified characters ---- - -# Series.str.endsWith - -> danfo.Series.str.**endsWith**(str, options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/strings.js#L133)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------- | ------------------------------------------------------ | -| str | string | the character(s) to check | "" | -| options | Object | **inplace**: Whether to perform the operation in-place or not. |{
inplace: false
}
| - -**Returns**: Series (Boolean element) - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = ['lower', 'CAPITALS', 'this is a sentence', 'SwApCaSe'] -let sf = new dfd.Series(data) -sf.str.endsWith("e").print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ false ║ -╟───┼──────────────────────╢ -║ 1 │ false ║ -╟───┼──────────────────────╢ -║ 2 │ true ║ -╟───┼──────────────────────╢ -║ 3 │ true ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.str.includes.md b/api-reference-v1-stable/series/series.str.includes.md deleted file mode 100644 index 8918773..0000000 --- a/api-reference-v1-stable/series/series.str.includes.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -description: Checks whether a string contains the specified string/characters ---- - -# Series.str.includes - -> danfo.Series.str.includes(str, options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/strings.js#L147)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------- | ------------------------------------------------------ | -| str | string | the character(s) to check | "" | -| options | Object | **inplace**: Whether to perform the operation in-place or not. |{
inplace: false
}
| - -**Returns**: Series (boolean element) - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = ['lower', 'CAPITALS', 'this is a sentence', 'SwApCaSe'] -let sf = new dfd.Series(data) -sf.str.includes("C").print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ false ║ -╟───┼──────────────────────╢ -║ 1 │ true ║ -╟───┼──────────────────────╢ -║ 2 │ false ║ -╟───┼──────────────────────╢ -║ 3 │ true ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.str.indexof.md b/api-reference-v1-stable/series/series.str.indexof.md deleted file mode 100644 index 1d9e64f..0000000 --- a/api-reference-v1-stable/series/series.str.indexof.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -description: the position of the first found occurrence of a specified value in a string ---- - -# Series.str.indexOf - -> danfo.Series.str.indexOf(str, options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/strings.js#L161)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------- | ------------------------------------------------------ | -| str | string | the string to obtain its index | "" | -| options | Object | **inplace**: Whether to perform the operation in-place or not. |{
inplace: false
}
| - -**Returns:** Series - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = ['lower', 'CAPITALS', 'this is a sentence', 'SwApCaSe'] -let sf = new dfd.Series(data) -sf.str.indexOf("C").print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ -1 ║ -╟───┼──────────────────────╢ -║ 1 │ 0 ║ -╟───┼──────────────────────╢ -║ 2 │ -1 ║ -╟───┼──────────────────────╢ -║ 3 │ 4 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.str.join.md b/api-reference-v1-stable/series/series.str.join.md deleted file mode 100644 index 5bb77fe..0000000 --- a/api-reference-v1-stable/series/series.str.join.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -description: Join a new string value to all string elements in a Series. ---- - -# Series.str.join - -> danfo.Series.str.**join**(valToJoin, joinChar, options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/strings.js#L308)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------- | ------------------------------------------------------ | -| valToJoin | String | the string value you want to | "" | -| joinChar | String | The delimiter to specify the joining | " " | -| options | Object | **inplace**: Whether to perform the operation in-place or not. |{
inplace: false
}
| - -**Returns:** - - **** return **Series** - -**Examples** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = ['lower part', 'CAPITALS city', 'this is a sentence', 'SwAp CaSe'] -let sf = new dfd.Series(data) -sf.str.join("new", "_").print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤════════════════════════╗ -║ 0 │ lower part_new ║ -╟───┼────────────────────────╢ -║ 1 │ CAPITALS city_new ║ -╟───┼────────────────────────╢ -║ 2 │ this is a sentence_new ║ -╟───┼────────────────────────╢ -║ 3 │ SwAp CaSe_new ║ -╚═══╧════════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.str.lastindexof.md b/api-reference-v1-stable/series/series.str.lastindexof.md deleted file mode 100644 index 889a1f4..0000000 --- a/api-reference-v1-stable/series/series.str.lastindexof.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: >- - Obtain the position of the last found occurrence of a specified value in a - string ---- - -# Series.str.lastIndexOf - -danfo.Series.str.lastIndexOf(str, options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/strings.js#L175)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------- | ------------------------------------------------------ | -| str | string | the string to search for | "" | -| options | Object | **inplace**: Whether to perform the operation in-place or not. |{
inplace: false
}
| - -**Returns**: Series - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = ['lower', 'CAPITALS', 'this is a sentence', 'SwApCaSe'] -let sf = new dfd.Series(data) -sf.str.lastIndexOf("r").print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 4 ║ -╟───┼──────────────────────╢ -║ 1 │ -1 ║ -╟───┼──────────────────────╢ -║ 2 │ -1 ║ -╟───┼──────────────────────╢ -║ 3 │ -1 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/series/series.str.len.md b/api-reference-v1-stable/series/series.str.len.md deleted file mode 100644 index 0ef06b2..0000000 --- a/api-reference-v1-stable/series/series.str.len.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -description: Obtain the length of each string element in a Series ---- - -# Series.str.len - -> danfo.Series.str.**len**(options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/strings.js#L324)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------- | ------------------------------------------------------ | -| options | Object | **inplace**: Whether to perform the operation in-place or not. |{
inplace: false
}
| - -**Examples** - -Returns the length (number of character) of a string, and also return the length (number of elements) of Array - -{% tabs %} -{% tab title="JavaScript" %} -```javascript -const dfd = require("danfojs-node") - -let data = ["dog", 5,"cat","fog","mug","animals"] -let sf = new dfd.Series(data) -sf.str.len().print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤═══╗ -║ 0 │ 3 ║ -╟───┼───╢ -║ 1 │ 1 ║ -╟───┼───╢ -║ 2 │ 3 ║ -╟───┼───╢ -║ 3 │ 3 ║ -╟───┼───╢ -║ 4 │ 3 ║ -╟───┼───╢ -║ 5 │ 7 ║ -╚═══╧═══╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.str.repeat.md b/api-reference-v1-stable/series/series.str.repeat.md deleted file mode 100644 index 703be26..0000000 --- a/api-reference-v1-stable/series/series.str.repeat.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -description: Repeat the the character(s) in a string for a specified number of time ---- - -# Series.str.repeat - -> danfo.Series.str.**repeat**(num, options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/strings.js#L205)] - -| Parameters | Type | Description | Default | -| ---------- | ------- | --------------------------------------------------------------- | ------------------------------------------------------ | -| num | integer | the string to search for | 1 | -| options | Object | **inplace**: Whether to perform the operation in-place or not. |{
inplace: false
}
| - -**Returns:** Series - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = ['a', 'b', 'c', 'd'] -let sf = new dfd.Series(data) -sf.str.repeat(4).print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ aaaa ║ -╟───┼──────────────────────╢ -║ 1 │ bbbb ║ -╟───┼──────────────────────╢ -║ 2 │ cccc ║ -╟───┼──────────────────────╢ -║ 3 │ dddd ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.str.replace.md b/api-reference-v1-stable/series/series.str.replace.md deleted file mode 100644 index 2b06b1f..0000000 --- a/api-reference-v1-stable/series/series.str.replace.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -description: Replace a word or character(s) in a String element ---- - -# Series.str.replace - -> danfo.Series.str.replace(searchValue, replaceValue, options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/strings.js#L191)] - -| Parameters | Type | Description | Default | -| ------------ | ------ | --------------------------------------------------------------- | ------------------------------------------------------ | -| searchValue | string | String \| Character value to replace. Supports regex. | "" | -| replaceValue | String | string to replace the searched string | "" | -| options | Object | **inplace**: Whether to perform the operation in-place or not. |{
inplace: false
}
| - -**Returns:** Series - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = ['lower', 'CAPITALS', 'this is a sentence', 'SwApCaSe'] -let sf = new dfd.Series(data) -sf.str.replace("A", "XXX").print() -``` -{% endtab %} - -{% tab title="Browse" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ lower ║ -╟───┼──────────────────────╢ -║ 1 │ CXXXPITALS ║ -╟───┼──────────────────────╢ -║ 2 │ this is a sentence ║ -╟───┼──────────────────────╢ -║ 3 │ SwXXXpCaSe ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.str.search.md b/api-reference-v1-stable/series/series.str.search.md deleted file mode 100644 index 99fc428..0000000 --- a/api-reference-v1-stable/series/series.str.search.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -description: Obtain the index position of a searched character in a String ---- - -# Series.str.search - -> danfo.Series.str.**search**(str, options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/strings.js#L220)] - - - -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------- | ------------------------------------------------------ | -| str | String | the string to search for | "" | -| options | Object | **inplace**: Whether to perform the operation in-place or not. |{
inplace: false
}
| - -**Returns:** - - **** return Series: Series of index position - -**Example** - -obtain the index position for a character - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = ['lower part ', ' CAPITALS city', ' this is a sentence', ' SwAp CaSe'] -let sf = new dfd.Series(data) -sf.str.search("S").print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ -1 ║ -╟───┼──────────────────────╢ -║ 1 │ 8 ║ -╟───┼──────────────────────╢ -║ 2 │ -1 ║ -╟───┼──────────────────────╢ -║ 3 │ 2 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -Obtain the index position for a searched word - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = ['lower city ', ' CAPITALS city', ' this is a sentence', ' SwAp CaSe'] -let sf = new dfd.Series(data) -sf.str.search("city").print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 6 ║ -╟───┼──────────────────────╢ -║ 1 │ 10 ║ -╟───┼──────────────────────╢ -║ 2 │ -1 ║ -╟───┼──────────────────────╢ -║ 3 │ -1 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.str.slice.md b/api-reference-v1-stable/series/series.str.slice.md deleted file mode 100644 index cef7a86..0000000 --- a/api-reference-v1-stable/series/series.str.slice.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: Obtain the substring of each element in a series ---- - -# Series.str.slice - -> danfo.Series.str.slice(startIndex, endIndex, options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/strings.js#L235)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------- | ------------------------------------------------------ | -| startIndex | Number | specify the index to start obtaining the substring | 0 | -| endIndex | Number | specify the index to end the substring | 1 | -| options | Object | **inplace**: Whether to perform the operation in-place or not. |{
inplace: false
}
| - -**Returns:** - - **** return Series. - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = ['lower part ', ' CAPITALS city', ' this is a sentence', ' SwAp CaSe'] -let sf = new dfd.Series(data) -sf.str.slice(2, 4).print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ we ║ -╟───┼──────────────────────╢ -║ 1 │ AP ║ -╟───┼──────────────────────╢ -║ 2 │ hi ║ -╟───┼──────────────────────╢ -║ 3 │ Sw ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.str.split.md b/api-reference-v1-stable/series/series.str.split.md deleted file mode 100644 index 006795d..0000000 --- a/api-reference-v1-stable/series/series.str.split.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -description: >- - Split string around a given separator/delimiter. The array of strings are then - converted to a string. ---- - -# Series.str.split - -> danfo.Series.str.**split**(splitVal, options) \[[source](https://github.com/opensource9ja/danfojs/blob/e25010c26d9c423412613d820015a48ad03d5c6d/danfojs-node/src/core/strings.js#L553)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | ---------------------------------------------------------- | ------------------------------- | -| splitVal | String | separator or delimiter used to split the string | " " | -| options | Object | **inplace**: Whether to perform operation in-place or not. |{
inplace: false
}
{
inplace: false
}
| - -**Returns:** Series (Boolean element) - -**Examples** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = ['lower', 'CAPITALS', 'this is a sentence', 'SwApCaSe'] -let sf = new dfd.Series(data) -sf.str.startsWith("S").print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ false ║ -╟───┼──────────────────────╢ -║ 1 │ false ║ -╟───┼──────────────────────╢ -║ 2 │ false ║ -╟───┼──────────────────────╢ -║ 3 │ true ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.str.substr.md b/api-reference-v1-stable/series/series.str.substr.md deleted file mode 100644 index 0a391bb..0000000 --- a/api-reference-v1-stable/series/series.str.substr.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -description: >- - Obtain the substring from a String element in a Series, by specifying the - number of string to obtain starting from a specific index. ---- - -# Series.str.substr - -> danfo.Series.str.substr(startIndex, num, options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/strings.js#L265)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------- | ------------------------------------------------------ | -| startIndex | Number | specify the index to start obtaining the substring | 0 | -| num | Number | The number of character to obtain starting from the startIndex | 1 | -| options | Object | **inplace**: Whether to perform the operation in-place or not. |{
inplace: false
}
| - -**Returns:** - - **** return Series - -**Example** - -Obtain substring( containing 4 characters) starting from the third character (2nd index). - -```javascript -const dfd = require("danfojs-node") - -let data = ['lower part ', ' CAPITALS city', ' this is a sentence', ' SwAp CaSe'] -let sf = new dfd.Series(data) -sf.str.substr(2, 4).print() -``` - -{% tabs %} -{% tab title="Output" %} -```javascript -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ wer ║ -╟───┼──────────────────────╢ -║ 1 │ APIT ║ -╟───┼──────────────────────╢ -║ 2 │ his ║ -╟───┼──────────────────────╢ -║ 3 │ SwAp ║ -╚═══╧══════════════════════╝ - -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.str.substring.md b/api-reference-v1-stable/series/series.str.substring.md deleted file mode 100644 index b54702e..0000000 --- a/api-reference-v1-stable/series/series.str.substring.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -description: Obtain the substring of each element in a series ---- - -# Series.str.substring - -> danfo.Series.str.**substring**(startIndex, endIndex, options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/strings.js#L280)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------- | ------------------------------------------------------ | -| startIndex | Number | specify the index to start obtaining the substring | 0 | -| endIndex | Number | specify the index to end the substring | 1 | -| options | Object | **inplace**: Whether to perform the operation in-place or not. |{
inplace: false
}
| - -**Returns** - - **** return **Series** - -**Example** - -Obtain the substring from index 2 to index 4 of the string elements in a Series - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = ['lower part ', ' CAPITALS city', ' this is a sentence', ' SwAp CaSe'] -let sf = new dfd.Series(data) -sf.str.substring(2, 4).print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ we ║ -╟───┼──────────────────────╢ -║ 1 │ AP ║ -╟───┼──────────────────────╢ -║ 2 │ hi ║ -╟───┼──────────────────────╢ -║ 3 │ Sw ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.str.tolowercase.md b/api-reference-v1-stable/series/series.str.tolowercase.md deleted file mode 100644 index 9abe0f5..0000000 --- a/api-reference-v1-stable/series/series.str.tolowercase.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -description: Converts all characters to lower case. ---- - -# Series.str.toLowerCase - -> danfo.Series.str.toLowerCase(options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/strings.js#L20)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------- | ------------------------------------------------------ | -| options | Object | **inplace**: Whether to perform the operation in-place or not. |{
inplace: false
}
| - -**Example** - -Convert all characters in each string element to small letter - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = ['LOWER BOY', 'CAPITALS', 'SENTENCE', 'SWAPCASE'] -let sf = new dfd.Series(data) -sf.str.toLowerCase().print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ lower boy ║ -╟───┼──────────────────────╢ -║ 1 │ capitals ║ -╟───┼──────────────────────╢ -║ 2 │ sentence ║ -╟───┼──────────────────────╢ -║ 3 │ swapcase ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.str.touppercase.md b/api-reference-v1-stable/series/series.str.touppercase.md deleted file mode 100644 index f484390..0000000 --- a/api-reference-v1-stable/series/series.str.touppercase.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -description: Converts all characters to uppercase. ---- - -# Series.str.toUpperCase - -> danfo.Series.str.toUpperCase(options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/strings.js#L33)] - -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------- | ------------------------------------------------------ | -| options | Object | **inplace**: Whether to perform the operation in-place or not. |{
inplace: false
}
| - -**Returns**: Series (String element) - -**Example** - -Convert all characters in each string element to capital letter - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = ['lower boy', 'CAPITALS', 'sentence', 'SwApCaSe'] -let sf = new dfd.Series(data) -sf.str.toUpperCase().print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ LOWER BOY ║ -╟───┼──────────────────────╢ -║ 1 │ CAPITALS ║ -╟───┼──────────────────────╢ -║ 2 │ SENTENCE ║ -╟───┼──────────────────────╢ -║ 3 │ SWAPCASE ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.str.trim.md b/api-reference-v1-stable/series/series.str.trim.md deleted file mode 100644 index 58b7b16..0000000 --- a/api-reference-v1-stable/series/series.str.trim.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -description: Remove leading and trailing Whitespace from a String element ---- - -# Series.str.trim - -> danfo.Series.str.**trim**(options) **\[**[**source**](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/strings.js#L293)**]** - -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------- | ------------------------------------------------------ | -| options | Object | **inplace**: Whether to perform the operation in-place or not. |{
inplace: false
}
| - -**Returns:** - - **** return Series - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data = ['lower part ', ' CAPITALS city', ' this is a sentence', ' SwAp CaSe'] -let sf = new dfd.Series(data) -sf.str.trim().print() -``` -{% endtab %} - -{% tab title="Browser" %} -``` -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ lower part ║ -╟───┼──────────────────────╢ -║ 1 │ CAPITALS city ║ -╟───┼──────────────────────╢ -║ 2 │ this is a sentence ║ -╟───┼──────────────────────╢ -║ 3 │ SwAp CaSe ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.sub.md b/api-reference-v1-stable/series/series.sub.md deleted file mode 100644 index e281d06..0000000 --- a/api-reference-v1-stable/series/series.sub.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -description: Return Subtraction of series and other, element-wise (binary operator sub). ---- - -# Series.sub - -> danfo.Series.sub(other, options) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L148)] - -| Parameters | Type | Description | Default | -| ---------- | ------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------- | -| other | Series\|int\| | values | | -| options | Object | inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false |{
inplace: false
}
| - -**Return:** Series - -**Example** - -subtract from values of another series - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [30, 40, 3, 5] -let data2 = [1, 2, 3, 4] -let sf1 = new dfd.Series(data1) -let sf2 = new dfd.Series(data2) -sf1.sub(sf2).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 29 ║ -╟───┼──────────────────────╢ -║ 1 │ 38 ║ -╟───┼──────────────────────╢ -║ 2 │ 0 ║ -╟───┼──────────────────────╢ -║ 3 │ 1 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - -subtract from a value - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [1, 2, 3, 4, 5] -let sf1 = new dfd.Series(data1) - -sf1.sub(2).print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ -1 ║ -╟───┼──────────────────────╢ -║ 1 │ 0 ║ -╟───┼──────────────────────╢ -║ 2 │ 1 ║ -╟───┼──────────────────────╢ -║ 3 │ 2 ║ -╟───┼──────────────────────╢ -║ 4 │ 3 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/series/series.sum.md b/api-reference-v1-stable/series/series.sum.md deleted file mode 100644 index fabcba7..0000000 --- a/api-reference-v1-stable/series/series.sum.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -description: Return the sum of the values in a series. ---- - -# Series.sum - -> danfo.Series.sum() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L333)] - -**Parameter:** None - -**Return:** Number - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [20, 30, 1, 2, 4, 57, 89, 0, 4] -let sf1 = new dfd.Series(data1) - -console.log(sf1.sum()) -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -207 -``` -{% endtab %} -{% endtabs %} - -**** diff --git a/api-reference-v1-stable/series/series.tail.md b/api-reference-v1-stable/series/series.tail.md deleted file mode 100644 index 7f986a1..0000000 --- a/api-reference-v1-stable/series/series.tail.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -description: Prints the last n values in a Series ---- - -# Series.tail - -> danfo.Series.tail\(rows\) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L76)\] - -| Parameters | Type | Description | Default | -| :--- | :--- | :--- | :--- | -| rows | Int | number of last n values | 5 | - - **Return:** Series - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [1, 2, 3, 4, 5, 620, 30, 40, 39, 89, 78] -let sf1 = new dfd.Series(data1) - -sf1.tail().print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```text -╔════╤══════════════════════╗ -║ │ 0 ║ -╟────┼──────────────────────╢ -║ 6 │ 30 ║ -╟────┼──────────────────────╢ -║ 7 │ 40 ║ -╟────┼──────────────────────╢ -║ 8 │ 39 ║ -╟────┼──────────────────────╢ -║ 9 │ 89 ║ -╟────┼──────────────────────╢ -║ 10 │ 78 ║ -╚════╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/series/series.tensor.md b/api-reference-v1-stable/series/series.tensor.md deleted file mode 100644 index a5c112c..0000000 --- a/api-reference-v1-stable/series/series.tensor.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -description: Obtain the tensor representation of the values in a Series ---- - -# Series.tensor - -> danfo.Series.tensor \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L45)\] - -**Parameters**: None - -**Returns**: Tensorflow tensor - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [30.21091, 40.190901, 3.564, 5.0212] -let sf1 = new dfd.Series(data1) - -console.log(sf1.tensor) -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```text -Tensor { - kept: false, - isDisposedInternal: false, - shape: [ 4 ], - dtype: 'float32', - size: 4, - strides: [], - dataId: {}, - id: 2, - rankType: '1', - scopeId: 0 -} -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/series/series.unique.md b/api-reference-v1-stable/series/series.unique.md deleted file mode 100644 index c89d187..0000000 --- a/api-reference-v1-stable/series/series.unique.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -description: Obtain the unique value in a Series ---- - -# Series.unique - -> danfo.Series.**unique**\(\) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L736)\] - -**Parameters**: None - -**Returns**: Series - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [1, 2, 3, 4, 5, 6, 7, 8, 1, 1, 22, 8, 5, 5, 5] -let sf = new dfd.Series(data1) - -sf.unique().print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```text -╔═══╤══════════════════════╗ -║ │ 0 ║ -╟───┼──────────────────────╢ -║ 0 │ 1 ║ -╟───┼──────────────────────╢ -║ 1 │ 2 ║ -╟───┼──────────────────────╢ -║ 2 │ 3 ║ -╟───┼──────────────────────╢ -║ 3 │ 4 ║ -╟───┼──────────────────────╢ -║ 4 │ 5 ║ -╟───┼──────────────────────╢ -║ 5 │ 6 ║ -╟───┼──────────────────────╢ -║ 6 │ 7 ║ -╟───┼──────────────────────╢ -║ 7 │ 8 ║ -╟───┼──────────────────────╢ -║ 8 │ 22 ║ -╚═══╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/series/series.value_counts.md b/api-reference-v1-stable/series/series.value_counts.md deleted file mode 100644 index 338064f..0000000 --- a/api-reference-v1-stable/series/series.value_counts.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: Count the number of occurrence for each element in a Series ---- - -# Series.value\_counts - -> danfo.Series.value\_counts() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L750)] - -**Parameters:** None - -**Returns:** Series (int element) - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [1, 2, 3, 4, 5, 6, 7, 8, 1, 1, 22, 8, 5, 5, 5] -let sf = new dfd.Series(data1) - -sf.value_counts().print() -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -``` -╔════╤══════════════════════╗ -║ │ 0 ║ -╟────┼──────────────────────╢ -║ 1 │ 3 ║ -╟────┼──────────────────────╢ -║ 2 │ 1 ║ -╟────┼──────────────────────╢ -║ 3 │ 1 ║ -╟────┼──────────────────────╢ -║ 4 │ 1 ║ -╟────┼──────────────────────╢ -║ 5 │ 4 ║ -╟────┼──────────────────────╢ -║ 6 │ 1 ║ -╟────┼──────────────────────╢ -║ 7 │ 1 ║ -╟────┼──────────────────────╢ -║ 8 │ 2 ║ -╟────┼──────────────────────╢ -║ 22 │ 1 ║ -╚════╧══════════════════════╝ -``` -{% endtab %} -{% endtabs %} diff --git a/api-reference-v1-stable/series/series.values.md b/api-reference-v1-stable/series/series.values.md deleted file mode 100644 index 4857487..0000000 --- a/api-reference-v1-stable/series/series.values.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -description: Obtain the values in a series ---- - -# Series.values - -> danfo.Series.values \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/generic.js#L279)\] - -**Parameters:** None - -**Returns**: Array - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [30.21091, 40.190901, 3.564, 5.0212] -let sf1 = new dfd.Series(data1) - -console.log(sf1.values) -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```text -[ 30.21091, 40.190901, 3.564, 5.0212 ] -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference-v1-stable/series/series.var.md b/api-reference-v1-stable/series/series.var.md deleted file mode 100644 index 4fdcbc2..0000000 --- a/api-reference-v1-stable/series/series.var.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -description: Calculate the variance of a Series ---- - -# Series.var - -> danfo.Series.var\(\) \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/series.js#L436)\] - -**Parameter:** None - -**Return:** Number - -**Example** - -{% tabs %} -{% tab title="Node" %} -```javascript -const dfd = require("danfojs-node") - -let data1 = [20, 30, 1, 2, 4, 57, 89, 0, 4] -let sf1 = new dfd.Series(data1) - -console.log(sf1.var()) -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Output" %} -```text -968.25 -``` -{% endtab %} -{% endtabs %} - diff --git a/api-reference/dataframe/creating-a-dataframe.md b/api-reference/dataframe/creating-a-dataframe.md index 2103b9d..b19e5f9 100644 --- a/api-reference/dataframe/creating-a-dataframe.md +++ b/api-reference/dataframe/creating-a-dataframe.md @@ -11,7 +11,7 @@ danfo.**DataFrame**(data, options) | data | 2D Array, 2D Tensor, JSON object. | Flat data structure to load into DataFrame | | options | Object |Optional configuration object. Supported properties are:
index: Array of numeric or string names for subseting array. If not specified, indexes are auto-generated.
columns: Array of column names. If not specified, column names are auto generated.
dtypes: Array of data types for each the column. If not specified, dtypes are/is inferred.
config: General configuration object for extending or setting NDframe behavior. See full options here
| -In order to create a DataFrame, you new to call the new Keyword and pass in a flat data structure. In the following examples, we show you how to create DataFrames by specifying different config options. +In order to create a DataFrame, you need to call the new Keyword and pass in a flat data structure. In the following examples, we show you how to create DataFrames by specifying different config options. ### Creating a `DataFrame` from a JSON object: @@ -40,7 +40,7 @@ df.print() -{
axis: 0 for column, 1 for row (default).
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
}
| { axis: 1, inplace: false } | + +## **Examples** + +### Difference with **previous row** of current DataFrame along default axis 1 + +{% tabs %} +{% tab title="Node" %} + +```javascript +import * as dfd from "danfojs"; + +const data = [ + [0, 2, 4], + [10, 10, 10], + [1, 2, 3], +]; + +const df = new dfd.DataFrame(data); + +const df_new = df.diff(1); + +df_new.print(); +``` + +{% endtab %} + +{% tab title="Browser" %} + +```html + + + + + + + + + + + + +``` + +{% endtab %} +{% endtabs %} + +{% tabs %} +{% tab title="Output" %} + +``` +╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ +║ │ Col1 │ Col2 │ Col3 ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 0 │ NaN │ NaN │ NaN ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 1 │ 10 │ 8 │ 6 ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 2 │ -9 │ -8 │ -7 ║ +╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ + +``` + +{% endtab %} +{% endtabs %} + +### Difference with **following row** of current DataFrame along default axis 1 + +{% tabs %} +{% tab title="Node" %} + +```javascript +import * as dfd from "danfojs"; + +const data = [ + [0, 2, 4], + [10, 10, 10], + [1, 2, 3], +]; + +const df = new dfd.DataFrame(data); + +const df_new = df.diff(-1); + +df_new.print(); +``` + +{% endtab %} + +{% tab title="Browser" %} + +```html + + + + + + + + + + + + +``` + +{% endtab %} +{% endtabs %} + +{% tabs %} +{% tab title="Output" %} + +``` +╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ +║ │ Col1 │ Col2 │ Col3 ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 0 │ -10 │ -8 │ -6 ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 1 │ 10 │ 8 │ 6 ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 2 │ NaN │ NaN │ NaN ║ +╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ + +``` + +{% endtab %} +{% endtabs %} + +### Difference with **Series** and DataFrame along axis 1 + +{% tabs %} +{% tab title="Node" %} + +```javascript +import * as dfd from "danfojs"; + +const data = [ + [0, 2, 4], + [10, 10, 10], + [1, 2, 3], +]; + +const df = new dfd.DataFrame(data); + +const sf = new dfd.Series([1, 2, 1]); + +const df_new = df.diff(sf); + +df_new.print(); +``` + +{% endtab %} + +{% tab title="Browser" %} + +```html + + + + + + + + + + + + +``` + +{% endtab %} +{% endtabs %} + +{% tabs %} +{% tab title="Output" %} + +``` +╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ +║ │ Col1 │ Col2 │ Col3 ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 0 │ -1 │ 0 │ 3 ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 1 │ 9 │ 8 │ 9 ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 2 │ 0 │ 0 │ 2 ║ +╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ + +``` + +{% endtab %} +{% endtabs %} + +### Difference between DataFrame and **another** DataFrame + +{% tabs %} +{% tab title="Node" %} + +```javascript +import * as dfd from "danfojs"; + +const data = [ + [0, 2, 4], + [3, 10, 4], +]; + +const original_df = new dfd.DataFrame(data); + +const comparison_df = new dfd.DataFrame([ + [-1, -2, 4], + [10, 5, 0], +]); + +const df_new = original_df.diff(comparison_df); + +df_new.print(); +``` + +{% endtab %} + +{% tab title="Browser" %} + +```html + + + + + + + + + + + + +``` + +{% endtab %} +{% endtabs %} + +{% tabs %} +{% tab title="Output" %} + +``` +╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ +║ │ Col1 │ Col2 │ Col3 ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 0 │ 1 │ 4 │ 0 ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 1 │ -7 │ 5 │ 4 ║ +╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ + +``` + +{% endtab %} +{% endtabs %} diff --git a/api-reference/dataframe/danfo.dataframe.groupby.md b/api-reference/dataframe/danfo.dataframe.groupby.md index b0adffc..30f4721 100644 --- a/api-reference/dataframe/danfo.dataframe.groupby.md +++ b/api-reference/dataframe/danfo.dataframe.groupby.md @@ -65,7 +65,7 @@ A groupby operation will return a GroupBy class object. You can apply any of the 6. [cumSum](danfo.dataframe.cumsum.md) 7. [cumMax](danfo.dataframe.cummax.md) 8. [cumProd](danfo.dataframe.cumprod.md) -9. [cummin](danfo.dataframe.cummin.md) +9. [cumMin](danfo.dataframe.cummin.md) 10. [max](danfo.dataframe.max.md) 11. [min](danfo.dataframe.min.md) diff --git a/api-reference/dataframe/danfo.dataframe.mod.md b/api-reference/dataframe/danfo.dataframe.mod.md index f3cda7c..7979969 100644 --- a/api-reference/dataframe/danfo.dataframe.mod.md +++ b/api-reference/dataframe/danfo.dataframe.mod.md @@ -53,7 +53,6 @@ df_new.print() ║ 3 │ 0 │ 0 ║ ╚════════════╧═══════════════════╧═══════════════════╝ - ``` {% endtab %} {% endtabs %} @@ -100,7 +99,6 @@ df_new.print() ║ 3 │ 1 │ 4 ║ ╚════════════╧═══════════════════╧═══════════════════╝ - ``` {% endtab %} {% endtabs %} @@ -148,7 +146,6 @@ df_new.print() ║ 3 │ 0 │ 0 ║ ╚════════════╧═══════════════════╧═══════════════════╝ - ``` {% endtab %} {% endtabs %} @@ -194,7 +191,6 @@ df_new.print() ╟────────────┼───────────────────┼───────────────────╢ ║ 3 │ 0 │ 0 ║ ╚════════════╧═══════════════════╧═══════════════════╝ - ``` {% endtab %} {% endtabs %} @@ -241,7 +237,6 @@ df.print() ║ 3 │ 0 │ 0 ║ ╚════════════╧═══════════════════╧═══════════════════╝ - ``` {% endtab %} {% endtabs %} diff --git a/api-reference/dataframe/danfo.dataframe.mul.md b/api-reference/dataframe/danfo.dataframe.mul.md index 41b2baf..a2e0071 100644 --- a/api-reference/dataframe/danfo.dataframe.mul.md +++ b/api-reference/dataframe/danfo.dataframe.mul.md @@ -4,7 +4,7 @@ description: Get Multiplication of dataframe and other, element-wise (binary ope # DataFrame.mul -danfo.DataFrame.mul(other, option) +danfo.DataFrame.mul(other, option) | Parameters | Type | Description | Default | | ---------- | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | @@ -143,7 +143,6 @@ df_new.print() ╟────────────┼───────────────────┼───────────────────╢ ║ 3 │ 0 │ 8 ║ ╚════════════╧═══════════════════╧═══════════════════╝ - ``` {% endtab %} {% endtabs %} @@ -190,7 +189,6 @@ df_new.print() ║ 3 │ 20 │ 48 ║ ╚════════════╧═══════════════════╧═══════════════════╝ - ``` {% endtab %} {% endtabs %} @@ -236,7 +234,6 @@ df.print() ╟────────────┼───────────────────┼───────────────────╢ ║ 3 │ 20 │ 48 ║ ╚════════════╧═══════════════════╧═══════════════════╝ - ``` {% endtab %} {% endtabs %} diff --git a/api-reference/dataframe/danfo.dataframe.pctChange.md b/api-reference/dataframe/danfo.dataframe.pctChange.md new file mode 100644 index 0000000..542029f --- /dev/null +++ b/api-reference/dataframe/danfo.dataframe.pctChange.md @@ -0,0 +1,305 @@ +--- +description: >- + Get percent difference between a dataframe and other. Accepts DataFrame, Series, number[] and number. +--- + +# DataFrame.pctChange + +danfo.DataFrame.pctChange(other, option) + +| Parameters | Type | Description | Default | +| ---------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------- | +| other | DataFrame, Series, Array or Scalar | Object to calculate difference with | | +| option | Object |{
axis: 0 for column, 1 for row (default).
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
}
| { axis: 1, inplace: false } | + +## **Examples** + +### Percent difference with **previous row** of current DataFrame along default axis 1 + +{% tabs %} +{% tab title="Node" %} + +```javascript +import * as dfd from "danfojs"; + +const data = [[90], [900], [900]]; + +const df = new dfd.DataFrame(data); + +const df_new = df.pctChange(1); + +df_new.print(); +``` + +{% endtab %} + +{% tab title="Browser" %} + +```html + + + + + + + + + + + + +``` + +{% endtab %} +{% endtabs %} + +{% tabs %} +{% tab title="Output" %} + +``` +╔════════════╤═══════════════════╗ +║ │ Col1 ║ +╟────────────┼───────────────────╢ +║ 0 │ NaN ║ +╟────────────┼───────────────────╢ +║ 1 │ 9 ║ +╟────────────┼───────────────────╢ +║ 2 │ 0 ║ +╚════════════╧═══════════════════╝ + +``` + +{% endtab %} +{% endtabs %} + +### Percentage difference with **following row** of current DataFrame along default axis 1 + +{% tabs %} +{% tab title="Node" %} + +```javascript +import * as dfd from "danfojs"; + +const data = [ + [0, 5, 15], + [10, 10, 10], + [1, 2, 5], +]; + +const df = new dfd.DataFrame(data); + +const df_new = df.pctChange(-1); + +df_new.print(); +``` + +{% endtab %} + +{% tab title="Browser" %} + +```html + + + + + + + + + + + + +``` + +{% endtab %} +{% endtabs %} + +{% tabs %} +{% tab title="Output" %} + +``` +╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ +║ │ Col1 │ Col2 │ Col3 ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 0 │ -1 │ -0.5 │ 0.5 ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 1 │ 9 │ 4 │ 1 ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 2 │ NaN │ NaN │ NaN ║ +╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ + +``` + +{% endtab %} +{% endtabs %} + +### Percentage difference with **Series** and DataFrame along axis 1 + +{% tabs %} +{% tab title="Node" %} + +```javascript +import * as dfd from "danfojs"; + +const data = [ + [0, 2, 4], + [10, 10, 10], + [1, 2, 3], +]; + +const df = new dfd.DataFrame(data); + +const sf = new dfd.Series([1, 2, 1]); + +const df_new = df.pctChange(sf); + +df_new.print(); +``` + +{% endtab %} + +{% tab title="Browser" %} + +```html + + + + + + + + + + + + +``` + +{% endtab %} +{% endtabs %} + +{% tabs %} +{% tab title="Output" %} + +``` +╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ +║ │ Col1 │ Col2 │ Col3 ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 0 │ -1 │ 0 │ 3 ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 1 │ 9 │ 4 │ 9 ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 2 │ 0 │ 0 │ 2 ║ +╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ + +``` + +{% endtab %} +{% endtabs %} + +### Percentage difference between DataFrame and **another** DataFrame + +{% tabs %} +{% tab title="Node" %} + +```javascript +import * as dfd from "danfojs"; + +const data = [ + [0, 2, 4], + [3, 10, 4], +]; + +const original_df = new dfd.DataFrame(data); + +const comparison_df = new dfd.DataFrame([ + [-1, -2, 4], + [6, 5, 0], +]); + +const df_new = original_df.pctChange(comparison_df); + +df_new.print(); +``` + +{% endtab %} + +{% tab title="Browser" %} + +```html + + + + + + + + + + + + +``` + +{% endtab %} +{% endtabs %} + +{% tabs %} +{% tab title="Output" %} + +``` +╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ +║ │ Col1 │ Col2 │ Col3 ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 0 │ -1 │ -2 │ 0 ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 1 │ -0.5 │ 1 │ -1 ║ +╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ + +``` + +{% endtab %} +{% endtabs %} diff --git a/api-reference/dataframe/danfo.dataframe.pow.md b/api-reference/dataframe/danfo.dataframe.pow.md index 8a1bae7..1f2926d 100644 --- a/api-reference/dataframe/danfo.dataframe.pow.md +++ b/api-reference/dataframe/danfo.dataframe.pow.md @@ -6,7 +6,7 @@ description: >- # DataFrame.pow -danfo.DataFrame.pow(other, option) +danfo.DataFrame.pow(other, option) | Parameters | Type | Description | Default | | ---------- | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | @@ -55,7 +55,6 @@ df_new.print() ║ 3 │ 100 │ 576 ║ ╚════════════╧═══════════════════╧═══════════════════╝ - ``` {% endtab %} {% endtabs %} @@ -102,7 +101,6 @@ df_new.print() ║ 3 │ 1 │ 1024 ║ ╚════════════╧═══════════════════╧═══════════════════╝ - ``` {% endtab %} {% endtabs %} @@ -150,7 +148,6 @@ df_new.print() ║ 3 │ 0 │ 16 ║ ╚════════════╧═══════════════════╧═══════════════════╝ - ``` {% endtab %} {% endtabs %} @@ -196,7 +193,6 @@ df_new.print() ╟────────────┼───────────────────┼───────────────────╢ ║ 3 │ 100 │ 576 ║ ╚════════════╧═══════════════════╧═══════════════════╝ - ``` {% endtab %} {% endtabs %} @@ -243,7 +239,6 @@ df.print() ║ 3 │ 100 │ 576 ║ ╚════════════╧═══════════════════╧═══════════════════╝ - ``` {% endtab %} {% endtabs %} diff --git a/api-reference/dataframe/dataframe.astype.md b/api-reference/dataframe/dataframe.astype.md index 45adf39..5e0d9cd 100644 --- a/api-reference/dataframe/dataframe.astype.md +++ b/api-reference/dataframe/dataframe.astype.md @@ -8,7 +8,7 @@ danfo.DataFrame.asType(options) | Parameters | Type | Description | Default | | ---------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | -| options | Object |{
column: Array, label/column name of column to cast
dtype: dtype to cast to. One of [string, float32, int32, boolean]
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
}
| { inplace: false } | +| options | Object |{
column: String, label/column name of column to cast
dtype: dtype to cast to. One of [string, float32, int32, boolean]
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
}
| { inplace: false } | ## **Examples** diff --git a/api-reference/dataframe/dataframe.at.md b/api-reference/dataframe/dataframe.at.md new file mode 100644 index 0000000..180413d --- /dev/null +++ b/api-reference/dataframe/dataframe.at.md @@ -0,0 +1,36 @@ +--- +description: Access a single value for a row/column label pair. +--- + +# DataFrame.at + +> danfo.DataFrame.at(row, column) + +| Parameters | Type | Description | Default | +| ---------- | -------------- | ------------------------- | ------- | +| row | Number, String | row position in the index | | +| column | String | Column position | | + +**Return:** Scalar + + + +{% tabs %} +{% tab title="Node" %} +```javascript +const dfd = require("danfojs-node") + +let data = { + "Name": ["Apples", "Mango", "Banana", "Pear"], + "Count": [21, 5, 30, 10], + "Price": [200, 300, 40, 250] +} + +let df = new dfd.DataFrame(data, { index: [1, "b", "c", "d"] }) +df.at(1, "Count") + +//output +21 +``` +{% endtab %} +{% endtabs %} diff --git a/api-reference/dataframe/dataframe.iat.md b/api-reference/dataframe/dataframe.iat.md new file mode 100644 index 0000000..c50f4f3 --- /dev/null +++ b/api-reference/dataframe/dataframe.iat.md @@ -0,0 +1,36 @@ +--- +description: Access a single value for a row/column pair by integer position. +--- + +# DataFrame.iat + +> danfo.DataFrame.iat(row, column) + +| Parameters | Type | Description | Default | +| ---------- | ------ | --------------------- | ------- | +| row | Number | row index position | | +| column | Number | Column index position | | + +**Return:** Scalar + + + +{% tabs %} +{% tab title="Node" %} +```javascript +const dfd = require("danfojs-node") + +let data = { + "Name": ["Apples", "Mango", "Banana", "Pear"], + "Count": [21, 5, 30, 10], + "Price": [200, 300, 40, 250] +} + +let df = new dfd.DataFrame(data, { index: [1, "b", "c", "d"] }) +df.iat(1, 2) + +//output +300 +``` +{% endtab %} +{% endtabs %} diff --git a/api-reference/dataframe/dataframe.sort_values.md b/api-reference/dataframe/dataframe.sort_values.md index 9aedc7b..03b8981 100644 --- a/api-reference/dataframe/dataframe.sort_values.md +++ b/api-reference/dataframe/dataframe.sort_values.md @@ -6,10 +6,10 @@ description: Sort a Dataframe in ascending or descending order by a specified co danfo.DataFrame.**sortValues**(by, options) \[[source](https://github.com/opensource9ja/danfojs/blob/cf5c7ae3a009458e61eedd18d9c9b5b6b10d5276/danfojs/src/core/frame.js#L125)] -| Parameters | Type | Description | Default | -| ---------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| **by** | Object | This key can be either a single column name or a single array of the same length as the calling DataFrame. | | -| options | Object |Optional configuration:
ascending: Order of sorting
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
|{
ascending: true, inplace: false
}
| +| Parameters | Type | Description | Default | +| ---------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------- | +| **by** | Object | This key can be either a single column name or a single array of the same length as the calling DataFrame. | | +| options | Object |Optional configuration:
ascending: Order of sorting
inplace: Boolean indicating whether to perform the operation inplace or not. Defaults to false
|{
ascending: true, inplace: false
}
| ## **Examples** @@ -86,9 +86,9 @@ df.print() ╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ ║ │ A │ B │ C ║ ╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ -20 │ 34 │ 20 ║ +║ 0 │ 47.3 │ 6 │ 30 ║ ╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 47.3 │ 6 │ 30 ║ +║ 2 │ -20 │ 34 │ 20 ║ ╟────────────┼───────────────────┼───────────────────┼───────────────────╢ ║ 1 │ 30 │ 5 │ 3 ║ ╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ diff --git a/api-reference/dataframe/dataframe.to_csv.md b/api-reference/dataframe/dataframe.to_csv.md index 504cbcc..101cb4b 100644 --- a/api-reference/dataframe/dataframe.to_csv.md +++ b/api-reference/dataframe/dataframe.to_csv.md @@ -4,12 +4,16 @@ description: Convert DataFrame to a comma-separated values (CSV) # DataFrame.toCSV -DataFrame.toCSV(options) +{% hint style="danger" %} +Deprecated in v1.1.0: Use the [`dfd.toCSV`](../input-output/danfo.to\_csv.md) function directly instead +{% endhint %} -| | | | | -| -------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | -| **Parameters** | Type | Description | Default | -| **options** | object, optional |Configuration object:
filePath: Local file path to write the CSV file to. If not specified, the CSV will be returned as a string. Only needed in Nodejs version
fileName: The name of the file to download as. Only needed in browser environment.
download: Boolean indicating whether to automatically download the CSV file in the browser. Only needed in the browser environment.
header: Boolean indicating whether to include a header row in the CSV file.
sep: Character to be used as a separator in the CSV file.
{
sep: ","
}
Configuration object:
filePath: Local file path to write the CSV file to. If not specified, the CSV will be returned as a string. Only needed in Nodejs version
fileName: The name of the file to download as. Only needed in browser environment.
download: Boolean indicating whether to automatically download the CSV file in the browser. Only needed in the browser environment.
header: Boolean indicating whether to include a header row in the CSV file.
sep: Character to be used as a separator in the CSV file.
{
sep: ","
}
Configuration object:
filePath: Local file path to write the CSV file to. If not specified, the CSV will be returned as a string. Only needed in Nodejs version
fileName: The name of the file to download as. Only needed in the browser environment.
sheetName: Name to call the excel sheet.
{
filePath: "./output.xlsx",
sheetName: "Sheet1"
}
Configuration object:
filePath: Local file path to write the CSV file to. If not specified, the CSV will be returned as a string. Only needed in Nodejs version
fileName: The name of the file to download as. Only needed in the browser environment.
sheetName: Name to call the excel sheet.
{
filePath: "./output.xlsx",
sheetName: "Sheet1"
}
Configuration object:
filePath: Local file path to write the CSV file to. If not specified, the CSV will be returned as a string. Only needed in Nodejs version
fileName: The name of the file to download as. Only needed in browser environment.
format: The format of the JSON. Can be one of row or column.
{format: "column"
}
Configuration object:
filePath: Local file path to write the CSV file to. If not specified, the CSV will be returned as a string. Only needed in Nodejs version
fileName: The name of the file to download as. Only needed in browser environment.
format: The format of the JSON. Can be one of row or column.
{format: "column"
}
The transformer function to apply to each row.
Note that each row of the CSV file is passed as a DataFrame with a single row to the transformer function, and the transformer function is expected to return a transformed DataFrame.
| +| transformer | Function |The transformer function to apply to each row.
Note that each row of the CSV file is passed as a DataFrame with a single row to the transformer function, and the transformer function is expected to return a transformed DataFrame.
| | options | object |Configuration options for the pipeline. These include:
outputFilePath The local file path to write the transformed CSV file to.customCSVStreamWriter A custom CSV stream writer function. This is applied at the end of each transform. If not provided, a default CSV stream writer is used, and this writes to local storage.inputStreamOptions Configuration options for the input stream. Supports all Papaparse CSV reader config options.outputStreamOptions Configuration options for the output stream. This is only applied when using the default CSV stream writer. Supports all toCSV options.{
inplace: sBoolean indicating whether to perform the operation inplace or not. Defaults to false
}
| {inplace: false} | +**Parameters**: None -**Returns:** +**Return**: DataFrame - **** return **DataFrame** +**Examples** -## **Examples** +Obtain the size of each group for dataframe grouped by one column {% tabs %} {% tab title="Node" %} ```javascript const dfd = require("danfojs-node") -let data = { - "A": [-20, 30, 47.3], - "B": [34, 5, 6], - "C": [20, 3, 30] -} +let data ={A: ['foo', 'bar', 'foo', 'bar', + 'foo', 'bar', 'foo', 'foo'], + B: ['one', 'one', 'two', 'three', + 'two', 'two', 'one', 'three'], + C: [1,3,2,4,5,2,6,7], + D: [3,2,4,1,5,6,7,8] + } + +let df = new dfd.DataFrame(data) +let grp = df.groupby(["A"]) +grp.size().print() +``` +{% endtab %} +{% endtabs %} +``` +╔════════════╤═══════════════════╤═══════════════════╗ +║ │ A_Group │ applyOps ║ +╟────────────┼───────────────────┼───────────────────╢ +║ 0 │ foo │ 5 ║ +╟────────────┼───────────────────┼───────────────────╢ +║ 1 │ bar │ 3 ║ +╚════════════╧═══════════════════╧═══════════════════╝ +``` -let df = new dfd.DataFrame(data, { index: ["a", "b", "c"] }) -df.print() +Obtain the size of each group in dataframe grouped by two columns -df.reset_index({ inplace: true }) //inplace -//df = df.reset_index() //not in inplace +{% tabs %} +{% tab title="Node" %} +```javascript +const dfd = require("danfojs-node") -df.print() -``` -{% endtab %} +let data ={A: ['foo', 'bar', 'foo', 'bar', + 'foo', 'bar', 'foo', 'foo'], + B: ['one', 'one', 'two', 'three', + 'two', 'two', 'one', 'three'], + C: [1,3,2,4,5,2,6,7], + D: [3,2,4,1,5,6,7,8] +} -{% tab title="Browser" %} -``` +let df = new dfd.DataFrame(data) +let grp = df.groupby(["A","B"]) +grp.size().print() ``` {% endtab %} {% endtabs %} -{% tabs %} -{% tab title="Output" %} ``` - ╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ +║ │ A_Group │ B_Group │ applyOps ║ ╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ a │ -20 │ 34 │ 20 ║ +║ 0 │ foo │ one │ 2 ║ ╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ b │ 30 │ 5 │ 3 ║ +║ 1 │ foo │ two │ 2 ║ ╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ c │ 47.3 │ 6 │ 30 ║ -╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - -╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C ║ +║ 2 │ foo │ three │ 1 ║ ╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ -20 │ 34 │ 20 ║ +║ 3 │ bar │ one │ 1 ║ ╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ 30 │ 5 │ 3 ║ +║ 4 │ bar │ three │ 1 ║ ╟────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ 47.3 │ 6 │ 30 ║ +║ 5 │ bar │ two │ 1 ║ ╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ - ``` -{% endtab %} -{% endtabs %} + +**** \ No newline at end of file diff --git a/api-reference/groupby/groupby.std.md b/api-reference/groupby/groupby.std.md index c792a8e..f0d1516 100644 --- a/api-reference/groupby/groupby.std.md +++ b/api-reference/groupby/groupby.std.md @@ -4,7 +4,7 @@ description: Obtain the standard deviation per groups for specified columns # Groupby.std -> danfo.Groupby.**std**() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/groupby.js#L262)] +> danfo.Groupby.**std**() \[[source](https://github.com/javascriptdata/danfojs/blob/9bfda6dcb6b2b620591ec7b3340d35e3f801c8ab/src/danfojs-base/aggregators/groupby.ts#L448)] **Parameters**: None @@ -20,17 +20,15 @@ Obtain the standard deviation of a column for each group, group by one column const dfd = require("danfojs-node") -let data ={'A': ['foo', 'bar', 'foo', 'bar', +let data ={A: ['foo', 'bar', 'foo', 'bar', 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', + B: ['one', 'one', 'two', 'three', 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } + C: [1,3,2,4,5,2,6,7], + D: [3,2,4,1,5,6,7,8] +} let df = new dfd.DataFrame(data) - - let grp = df.groupby(["A"]) grp.col(["C"]).std().print() ``` @@ -58,13 +56,13 @@ Obtain the std for two columns for each group, group by one column const dfd = require("danfojs-node") -let data ={'A': ['foo', 'bar', 'foo', 'bar', +let data ={A: ['foo', 'bar', 'foo', 'bar', 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', + B: ['one', 'one', 'two', 'three', 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } + C: [1,3,2,4,5,2,6,7], + D: [3,2,4,1,5,6,7,8] +} let df = new dfd.DataFrame(data) @@ -94,13 +92,13 @@ Obtain the std for a column for each group, group by two columns const dfd = require("danfojs-node") -let data ={'A': ['foo', 'bar', 'foo', 'bar', +let data ={A: ['foo', 'bar', 'foo', 'bar', 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', + B: ['one', 'one', 'two', 'three', 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } + C: [1,3,2,4,5,2,6,7], + D: [3,2,4,1,5,6,7,8] +} let df = new dfd.DataFrame(data) @@ -137,13 +135,13 @@ Obtain the std for two columns for each group, group by two columns const dfd = require("danfojs-node") -let data ={'A': ['foo', 'bar', 'foo', 'bar', +let data ={A: ['foo', 'bar', 'foo', 'bar', 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', + B: ['one', 'one', 'two', 'three', 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } + C: [1,3,2,4,5,2,6,7], + D: [3,2,4,1,5,6,7,8] +} let df = new dfd.DataFrame(data) diff --git a/api-reference/groupby/groupby.sum.md b/api-reference/groupby/groupby.sum.md index f6f2900..6ad83df 100644 --- a/api-reference/groupby/groupby.sum.md +++ b/api-reference/groupby/groupby.sum.md @@ -4,7 +4,7 @@ description: Obtain the sum per groups for columns # Groupby.sum -> danfo.Groupby.sum() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/groupby.js#L256)] +> danfo.Groupby.sum() \[[source](https://github.com/javascriptdata/danfojs/blob/9bfda6dcb6b2b620591ec7b3340d35e3f801c8ab/src/danfojs-base/aggregators/groupby.ts#L440)] **Parameters**: None @@ -19,17 +19,16 @@ Obtain the sum of a column for each group, group by one column ```javascript const dfd = require("danfojs-node") -let data ={'A': ['foo', 'bar', 'foo', 'bar', +let data ={A: ['foo', 'bar', 'foo', 'bar', 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', + B: ['one', 'one', 'two', 'three', 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } + C: [1,3,2,4,5,2,6,7], + D: [3,2,4,1,5,6,7,8] +} let df = new dfd.DataFrame(data) - let grp = df.groupby(["A"]) grp.col(["C"]).sum().print() ``` @@ -38,8 +37,6 @@ grp.col(["C"]).sum().print() ``` - Shape: (2,2) - ╔═══╤═══════════════════╤═══════════════════╗ ║ │ A │ C_sum ║ ╟───┼───────────────────┼───────────────────╢ @@ -56,17 +53,16 @@ Obtain the sum for two columns for each group, group by one column ```javascript const dfd = require("danfojs-node") -let data ={'A': ['foo', 'bar', 'foo', 'bar', +let data ={A: ['foo', 'bar', 'foo', 'bar', 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', + B: ['one', 'one', 'two', 'three', 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } + C: [1,3,2,4,5,2,6,7], + D: [3,2,4,1,5,6,7,8] +} let df = new dfd.DataFrame(data) - let grp = df.groupby(["A"]) grp.col(["C","D"]).sum().print() ``` @@ -74,8 +70,6 @@ grp.col(["C","D"]).sum().print() {% endtabs %} ``` - Shape: (2,3) - ╔═══╤═══════════════════╤═══════════════════╤═══════════════════╗ ║ │ A │ C_sum │ D_sum ║ ╟───┼───────────────────┼───────────────────┼───────────────────╢ @@ -92,17 +86,16 @@ Obtain the sum for a column for each group, group by two columns ```javascript const dfd = require("danfojs-node") -let data ={'A': ['foo', 'bar', 'foo', 'bar', +let data ={A: ['foo', 'bar', 'foo', 'bar', 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', + B: ['one', 'one', 'two', 'three', 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } + C: [1,3,2,4,5,2,6,7], + D: [3,2,4,1,5,6,7,8] +} let df = new dfd.DataFrame(data) - let grp = df.groupby(["A","B"]) grp.col(["C"]).sum().print() ``` @@ -134,17 +127,16 @@ Obtain the sum for two columns for each group, group by two columns ```javascript const dfd = require("danfojs-node") -let data ={'A': ['foo', 'bar', 'foo', 'bar', +let data ={A: ['foo', 'bar', 'foo', 'bar', 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', + B: ['one', 'one', 'two', 'three', 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } + C: [1,3,2,4,5,2,6,7], + D: [3,2,4,1,5,6,7,8] +} let df = new dfd.DataFrame(data) - let grp = df.groupby(["A","B"]) grp.col(["C","D"]).sum().print() ``` @@ -152,21 +144,21 @@ grp.col(["C","D"]).sum().print() {% endtabs %} ``` - Shape: (5,4) - -╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ -║ │ A │ B │ C_sum │ D_sum ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 0 │ foo │ one │ 7 │ 10 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 1 │ foo │ two │ 7 │ 9 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 2 │ foo │ three │ 7 │ 8 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 3 │ bar │ one │ 3 │ 2 ║ -╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ -║ 4 │ bar │ two │ 2 │ 6 ║ -╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ +╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗ +║ │ A │ B │ C_sum │ D_sum ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 0 │ foo │ one │ 7 │ 10 ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 1 │ foo │ two │ 7 │ 9 ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 2 │ foo │ three │ 7 │ 8 ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 3 │ bar │ one │ 3 │ 2 ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 4 │ bar │ three │ 4 │ 1 ║ +╟────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢ +║ 5 │ bar │ two │ 2 │ 6 ║ +╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝ ``` **** diff --git a/api-reference/groupby/groupby.var.md b/api-reference/groupby/groupby.var.md index 373109f..08a9d97 100644 --- a/api-reference/groupby/groupby.var.md +++ b/api-reference/groupby/groupby.var.md @@ -4,7 +4,7 @@ description: Obtain the variance per groups for a specified column # Groupby.var -> danfo.Groupby.**var**() \[[source](https://github.com/opensource9ja/danfojs/blob/master/danfojs/src/core/groupby.js#L268)] +> danfo.Groupby.**var**() \[[source](https://github.com/javascriptdata/danfojs/blob/9bfda6dcb6b2b620591ec7b3340d35e3f801c8ab/src/danfojs-base/aggregators/groupby.ts#L456)] **Parameters**: None @@ -20,17 +20,16 @@ Obtain the variance of a column for each group, group by one column const dfd = require("danfojs-node") -let data ={'A': ['foo', 'bar', 'foo', 'bar', +let data ={A: ['foo', 'bar', 'foo', 'bar', 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', + B: ['one', 'one', 'two', 'three', 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } + C: [1,3,2,4,5,2,6,7], + D: [3,2,4,1,5,6,7,8] +} let df = new dfd.DataFrame(data) - let grp = df.groupby(["A"]) grp.col(["C"]).var().print() ``` @@ -58,13 +57,13 @@ Obtain the var for two columns for each group, group by one column const dfd = require("danfojs-node") -let data ={'A': ['foo', 'bar', 'foo', 'bar', +let data ={A: ['foo', 'bar', 'foo', 'bar', 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', + B: ['one', 'one', 'two', 'three', 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } + C: [1,3,2,4,5,2,6,7], + D: [3,2,4,1,5,6,7,8] +} let df = new dfd.DataFrame(data) @@ -94,13 +93,13 @@ Obtain the var for a column for each group, group by two columns const dfd = require("danfojs-node") -let data ={'A': ['foo', 'bar', 'foo', 'bar', +let data ={A: ['foo', 'bar', 'foo', 'bar', 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', + B: ['one', 'one', 'two', 'three', 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } + C: [1,3,2,4,5,2,6,7], + D: [3,2,4,1,5,6,7,8] +} let df = new dfd.DataFrame(data) @@ -137,13 +136,13 @@ Obtain the var for two columns for each group, group by two columns const dfd = require("danfojs-node") -let data ={'A': ['foo', 'bar', 'foo', 'bar', +let data ={A: ['foo', 'bar', 'foo', 'bar', 'foo', 'bar', 'foo', 'foo'], - 'B': ['one', 'one', 'two', 'three', + B: ['one', 'one', 'two', 'three', 'two', 'two', 'one', 'three'], - 'C': [1,3,2,4,5,2,6,7], - 'D': [3,2,4,1,5,6,7,8] - } + C: [1,3,2,4,5,2,6,7], + D: [3,2,4,1,5,6,7,8] +} let df = new dfd.DataFrame(data) diff --git a/api-reference/input-output/README.md b/api-reference/input-output/README.md index e86d5de..310be54 100644 --- a/api-reference/input-output/README.md +++ b/api-reference/input-output/README.md @@ -8,11 +8,11 @@ description: Functions for reading tabular/structured data into DataFrame/Series | \`\` | | | ----------------------------------- | -------------------------------------------------------- | -| [`read_csv`](danfo.read_csv.md) | Read a comma-separated values (csv) file into DataFrame. | +| [`readCSV`](danfo.read_csv.md) | Read a comma-separated values (csv) file into DataFrame. | | [`read_excel`](danfo.read_excel.md) | Read an Excel values (xlsx) file into DataFrame. | -| [`read_json`](danfo.read_json.md) | Read a JSON values (json) file into DataFrame. | -| [to_csv](danfo.to_csv.md) | Writes a DataFrame/Series to CSV file | +| [`readJSON`](danfo.read_json.md) | Read a JSON values (json) file into DataFrame. | +| [toCSV](danfo.to_csv.md) | Writes a DataFrame/Series to CSV file | | [to_excel](danfo.to_excel.md) | Writes a DataFrame/Series to Excel file | -| [to_json](danfo.to_json.md) | Writes a DataFrame/Series to JSON file | +| [toJSON](danfo.to_json.md) | Writes a DataFrame/Series to JSON file | -Writing to `CSV` and `JSON` can also be done directly from DataFrame or Series objects (e.g. [`DataFrame.to_csv()`](../dataframe/dataframe.to_csv.md)) +Writing to `CSV` and `JSON` can also be done directly from DataFrame or Series objects (e.g. [`DataFrame.toCSV()`](../dataframe/dataframe.to_csv.md)) diff --git a/api-reference/input-output/danfo.read_csv.md b/api-reference/input-output/danfo.read_csv.md index 870f105..c389d5d 100644 --- a/api-reference/input-output/danfo.read_csv.md +++ b/api-reference/input-output/danfo.read_csv.md @@ -66,7 +66,7 @@ dfd.readCSV("https://raw.githubusercontent.com/plotly/datasets/master/finance-ch - +{
sheet : string, (Optional) Name of the sheet which u want to parse. Default will be the first sheet.
method: The HTTP method to use.
headers: Additional headers to send with the request if reading JSON from remote url. Supports all the node-fetch options in Nodejs, and all fetch options in browsers.
}
| +| Parameters | Type | Description | +| ---------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| source | string | **source** : string, URL or local file path to Excel file. | +| options | Object |{
sheet : string, (Optional) Name of the sheet which u want to parse. Default will be the first sheet.
method: The HTTP method to use.
headers: Additional headers to send with the request if reading JSON from remote url. Supports all the node-fetch options in Nodejs, and all fetch options in browsers.
frameConfig: Optional arguments passed when creating the DataFrame. e.g column names, index. etc.
parsingOptions: supports all xlsx options. See https://docs.sheetjs.com/docs/api/parse-options
}
| ### Example @@ -40,7 +40,7 @@ load_process_data() - +Configuration object:
{
filePath: Local file path to write the CSV file to. If not specified, the CSV will be returned as a string. Only needed in Nodejs versionfileName: The name of the file to download as. Only needed in the browser environment.sheetName: Name to call the excel sheet.
}
|{
filePath: "./output.xlsx",
sheetName: "Sheet1"
}
Configuration object:
{
filePath: Local file path to write the CSV file to. If not specified, the CSV will be returned as a string. Only needed in Nodejs versionfileName: The name of the file to download as. Only needed in the browser environment.sheetName: Name to call the excel sheet.
writingOptions: Supports all xlsx write options. See https://docs.sheetjs.com/docs/api/write-options
}
|{
filePath: "./output.xlsx",
sheetName: "Sheet1"
}