docs: move docs to mkdocs

9 files changed, 540 insertions, 1 deletions

diff --git a/docs/assets/logo.png b/docs/assets/logo.png
new file mode 100644
index 0000000..37c5d91
--- /dev/null
+++ b/docs/assets/logo.png
diff --git a/docs/chaining-methods.md b/docs/chaining-methods.md
new file mode 100644
index 0000000..d50f710
--- /dev/null
+++ b/docs/chaining-methods.md
@@ -0,0 +1,16 @@
+# Chaining Methods
+
+Since, the row and column methods return a new frame, you can chain them together to get the data of multiple rows and columns. The following example shows how to get the data of multiple rows and columns.
+
+The returned data is also a new frame and you can continue chaining other frame methods on it.
+
+```js
+const data = [[...], [...], ...];
+const header = [...];
+const frame = new Frame(data, header);
+
+// 1. get multiple rows on Index 2 and 3
+// 2. then get the 'Name' and 'Age' columns of those rows
+// 3. finally print the data
+frame.row([2, 3]).column(['Name', 'Age']).show();
+```
diff --git a/docs/frame-methods.md b/docs/frame-methods.md
new file mode 100644
index 0000000..d830df4
--- /dev/null
+++ b/docs/frame-methods.md
@@ -0,0 +1,240 @@
+# Frame Methods
+
+There are some methods attached to the frame class. You can tap into those methods by using the dot (.) notation. Most of the methods are [chainable](../chaining-methods).
+
+### `data()` ![](https://img.shields.io/badge/chainable-green.svg?style=plastic)
+
+The `data()` method is used to modify the data in the frame. It takes the same data argument as the constructor – which is an array of arrays.
+
+> **Note:** If you use data method without passing any argument, it will simply return the frame.
+
+```js
+const data = [[...], [...], ...];
+const frame = new Frame();
+frame.data(data);
+
+// modify the data
+const newData = [[...], [...], [...], [...], ...];
+frame.data(newData);
+```
+
+### `header()` ![](https://img.shields.io/badge/chainable-green.svg?style=plastic)
+
+The `header()` method is used to modify the column names in the frame. It takes the same header argument as the constructor – which is an array of strings.
+
+> **Note:** If you use header method without passing any argument, it will reset the column names to default header (Remember: header is optional).
+
+```js
+// modify the header
+const newHeader = [...];
+frame.header(newHeader);
+
+// Reset the header to default
+frame.header();
+
+// You can use any empty value to reset the header to default, for example:
+// frame.header('');
+// frame.header(null);
+// frame.header(undefined);
+// frame.header([]);
+```
+
+### `column()` ![](https://img.shields.io/badge/chainable-green.svg?style=plastic)
+
+The `column()` method is used to get the column data of a particular column. It takes the column name or the index as an argument. It can also take an array of column names or indexes as an argument to get multiple columns.
+
+The `column()` method returns a new frame with extracted column data as the data of the frame. You can chain other frame methods on the returned frame.
+
+#### Get a single column
+
+```js
+// get a single column on Index 2 (Index starts from 0)
+const column = frame.column(2);
+
+// Alternatively, you can use the column name
+const column = frame.column('Name');
+
+// print the column
+column.show();
+```
+
+#### Get multiple columns
+
+```js
+// get multiple columns on Index 2 and 3 (Index starts from 0)
+const columns = frame.column([2, 3]);
+
+// Alternatively, you can use the column names
+const columns = frame.column(['Name', 'Age']);
+
+// print the columns
+columns.show();
+```
+
+### `row()` ![](https://img.shields.io/badge/chainable-green.svg?style=plastic)
+
+The `row()` method is used to get the row data of a particular row. It takes the row index as an argument. It can also take an array of row indexes as an argument to get multiple rows.
+
+The `row()` method returns a new frame with extracted row data as the data of the frame. You can chain other frame methods on the returned frame.
+
+#### Get a single row
+
+```js
+// get a single row on Index 2 (Index starts from 0)
+const row = frame.row(2);
+
+// print the row
+row.show();
+```
+
+#### Get multiple rows
+
+```js
+// get multiple rows on Index 2 and 3 (Index starts from 0)
+const rows = frame.row([2, 3]);
+
+// print the rows
+rows.show();
+```
+
+### `fromJSON()` ![](https://img.shields.io/badge/chainable-green.svg?style=plastic)
+
+The `fromJSON()` method is used to create a frame from a JSON object. It takes the JSON object as an argument. `fromJSON()` method returns a new frame. You can chain other frame methods on the returned frame.
+
+> **Note:** The `fromJSON()` method does not take nested JSON objects as an argument. If you have a nested JSON object, flatten it using the `flattenJSON()` helper function first.
+
+```js
+const json = [{...}, {...}, ...];
+const frame = new Frame().fromJSON(json);
+
+// ...continue with other frame methods
+```
+
+### `fromCSV()` ![](https://img.shields.io/badge/chainable-green.svg?style=plastic)
+
+The `fromCSV()` method is used to create a frame from a CSV string. It takes the CSV string as an argument. `fromCSV()` method returns a new frame. You can chain other frame methods on the returned frame.
+
+> **Note:** The `fromCSV()` automatically assigns the column names from the first row of the CSV string. If you do not want to use the column names, you can use the `header()` method to assign the column names first.
+
+```js
+
+const path = require('path');
+const csvPath = path.join(__dirname, 'data.csv');
+
+// Sets the column names from the first row of the CSV
+const frame = new Frame().fromCSV(csvPath);
+
+// Define the column names manually
+const headers = [...];
+
+// Set the header first (important) then read the CSV
+const frame = new Frame().header(headers).fromCSV(csvPath);
+```
+
+### `find()` ![](https://img.shields.io/badge/chainable-green.svg?style=plastic)
+
+The `find()` method is used to find the rows that match the given condition. It takes a string or a number as an argument which is needed to be found in the frame. Optionally, it also takes an `options` object as as the second argument.
+
+The valid options are defined below:
+
+  - `row`: The row index to seach in. Can also be an array of row indexes.
+  - `column`: The column name or index to search in. Can also be an array of column names or indexes.
+  - `strict`: If `true`, the search will be performed on the exact value. If `false`, the search will be performed on the value as a substring. Default is `false`.
+
+> **Hint**: You can also combine the `range()` helper method to pass a range of rows or columns.
+
+```js
+// find all the rows with value 'John' in column 'Name'
+const row = frame.find('John', {column: 'Name'});
+
+// find all the rows with value 'John' in columns 0, 1 and 2. Perform a strict search
+const row = frame.find('John', {column: [0, 1, 2], strict: true});
+
+// find all the rows with value 'John' in columns 0, 1 and 2 and rows 3, 4 and 5.
+// Perform a non-strict search
+const row = frame.find('John', {column: [0, 1, 2], row: [3, 4, 5], strict: false});
+```
+
+
+### `head()` ![](https://img.shields.io/badge/not%20chainable-red.svg?style=plastic)
+
+The `head()` method is used to get the first `n` rows of the frame. It takes the number of rows as an argument. If no argument is passed, it will return the first 5 rows. If the argument is greater than the number of rows in the frame, it will return the entire frame.
+
+`head()` is a print method and it does not return a new frame and therefore it is not chainable.
+
+```js
+// get the first 5 rows
+frame.head();
+
+// get the first 10 rows
+frame.head(10);
+```
+
+### `tail()` ![](https://img.shields.io/badge/not%20chainable-red.svg?style=plastic)
+
+The `tail()` method is used to get the last `n` rows of the frame. It takes the number of rows as an argument. If no argument is passed, it will return the last 5 rows. If the argument is greater than the number of rows in the frame, it will return the entire frame.
+
+`tail()` is a print method and it does not return a new frame and therefore it is not chainable.
+
+```js
+// get the last 5 rows
+frame.tail();
+
+// get the last 10 rows
+frame.tail(10);
+```
+
+### `show()` ![](https://img.shields.io/badge/not%20chainable-red.svg?style=plastic)
+
+The `show()` method is used to print the frame. It takes no argument.
+
+`show()` is a print method and it does not return a new frame and therefore it is not chainable.
+
+```js
+// print the frame
+frame.show();
+```
+
+### `info()` ![](https://img.shields.io/badge/not%20chainable-red.svg?style=plastic)
+
+The `info()` method is used to print the frame information. It takes no argument.
+
+`info()` is a print method and it does not return a new frame and therefore it is not chainable.
+
+```js
+// print the frame information
+frame.info();
+```
+
+If you run the `info()` method on the frame with [data defined in the Getting Started Section](https://github.com/luciferreeves/izuku.js/wiki/Getting-Started), it will print the following information:
+
+```
+RangeIndex: 35 elements, 0 to 34
+Shape: 9 rows, 4 columns
+╔═══╤═════════════╤══════════════════╤══════════════╗
+║ # │ Column Name │ Types            │ Empty Values ║
+╟───┼─────────────┼──────────────────┼──────────────╢
+║ 0 │ Name        │ string           │ false        ║
+╟───┼─────────────┼──────────────────┼──────────────╢
+║ 1 │ Age         │ number,object    │ true         ║
+╟───┼─────────────┼──────────────────┼──────────────╢
+║ 2 │ Gender      │ string           │ false        ║
+╟───┼─────────────┼──────────────────┼──────────────╢
+║ 3 │ Country     │ string,undefined │ true         ║
+╚═══╧═════════════╧══════════════════╧══════════════╝
+Data Types: string(26), number(8), object(1), undefined(1)
+Memory Usage: 550 bytes
+```
+
+### `rangeIndex()` ![](https://img.shields.io/badge/not%20chainable-red.svg?style=plastic)
+
+The `rangeIndex()` method is used to get the element at a particular index if the complete data was flattened. It takes an index as an argument. Index is zero-based.
+
+`rangeIndex()` does not return a new frame and therefore it is not chainable. It returns the element at the index and therefore a `console.log` is required to print the element.
+
+```js
+// get the element at index 2
+console.log(frame.rangeIndex(2));
+```
+
+There are some helper methods which will make your workflow easier. Take a look at the [Helper Methods](../helper-methods) section.
diff --git a/docs/frame-properties.md b/docs/frame-properties.md
new file mode 100644
index 0000000..2255556
--- /dev/null
+++ b/docs/frame-properties.md
@@ -0,0 +1,51 @@
+# Frame Properties
+
+There are some properties attached to the frame class. You can tap into those properties by using the dot (.) notation.
+
+> **Note:** Frame methods are not available on the properties. You need to `console.log(propertyName)` to see the property values.
+
+### `rowdata`
+
+The `rowdata` property is an array of arrays that represents the data in the frame.
+
+> **Note:** The `rowdata` property is read-only. If you want to modify the data in the frame, you can use the `data()` method.
+
+```js
+const rowdata = frame.rowdata;
+console.log(rowdata); // prints "data" array
+```
+
+### `columns`
+
+The `columns` property is an array of strings that represents the column names in the frame.
+
+> **Note:** The `columns` property is read-only. If you want to modify the column names in the frame, you can use the `header()` method.
+
+```js
+const columns = frame.columns;
+console.log(columns); // prints "header" array
+```
+
+### `size`
+
+The `size` property gives the number of elements present in the frame.
+
+> **Note:** The `size` property is read-only and is automatically generated when the frame is created. Size can change if data is modified.
+
+```js
+const size = frame.size;
+console.log(size); // prints size. ex: 9
+```
+
+### `shape`
+
+The `shape` property gives the number of rows and columns present in the frame.
+
+> **Note:** The `shape` property is read-only and is automatically generated when the frame is created. Shape can change if data is modified.
+
+```js
+const shape = frame.shape;
+console.log(shape); // prints shape. ex: 9 x 4
+```
+
+Now that you have a frame, you can use the frame methods to manipulate the data. Take a look at the [frame methods](../frame-methods).
diff --git a/docs/getting-started.md b/docs/getting-started.md
new file mode 100644
index 0000000..91789b9
--- /dev/null
+++ b/docs/getting-started.md
@@ -0,0 +1,64 @@
+# Getting Started
+
+## Installation
+
+Izuku is available on [npm](https://www.npmjs.com/package/izuku). To install Izuku, run the following command:
+
+```bash
+npm install izuku
+```
+
+## Basic Usage
+
+As defined in [Home](../), the basic usage of Izuku is to create a `Frame` object and manipulate it. You can use either an 2D array, a JSON Object, or a CSV File to create a `Frame`. The following example creates a `Frame` from a 2D array:
+
+```js
+import { Frame } from 'izuku';
+// alternatively, const { Frame } = require('izuku');
+
+// define some column names as an array
+const header = ['Name', 'Age', 'Gender', 'Country'];
+
+// define some data as a 2D array
+const data = [
+  ['Arthur', 21, 'Male', 'USA'],
+  ['Betty', 20, 'Female', 'Canada'],
+  ['Victor', 25, 'Male'],
+  ['Dodger', 30, 'Male', 'Canada'],
+  ['Rayan', 21, 'Male', 'Russia'],
+  ['Skitley', 29, 'Female', 'Germany'],
+  ['Victoria', 89, 'Female', 'UK'],
+  ['Tiger', 23, 'Male', 'India'],
+  ['Killjoy', null, 'Female', 'Riot']
+];
+
+// create a frame, header is optional
+const frame = new Frame(data, header);
+
+// print the frame
+frame.show();
+```
+
+The above code creates a frame and prints it to the console. It looks like this:
+
+```
+╔═══════╤══════════╤══════╤════════╤═════════╗
+║ Index │ Name     │ Age  │ Gender │ Country ║
+╟───────┼──────────┼──────┼────────┼─────────╢
+║ 0     │ Arthur   │ 21   │ Male   │ USA     ║
+╟───────┼──────────┼──────┼────────┼─────────╢
+║ 1     │ Betty    │ 20   │ Female │ Canada  ║
+╟───────┼──────────┼──────┼────────┼─────────╢
+║ 2     │ Victor   │ 25   │ Male   │         ║
+╟───────┼──────────┼──────┼────────┼─────────╢
+║ ...   │ ...      │ ...  │ ...    │ ...     ║
+╟───────┼──────────┼──────┼────────┼─────────╢
+║ 6     │ Victoria │ 89   │ Female │ UK      ║
+╟───────┼──────────┼──────┼────────┼─────────╢
+║ 7     │ Tiger    │ 23   │ Male   │ India   ║
+╟───────┼──────────┼──────┼────────┼─────────╢
+║ 8     │ Killjoy  │ null │ Female │ Riot    ║
+╚═══════╧══════════╧══════╧════════╧═════════╝
+```
+
+Now that you have created a frame, take a look at the [frame properties](../frame-properties).
diff --git a/docs/helper-methods.md b/docs/helper-methods.md
new file mode 100644
index 0000000..6fa056f
--- /dev/null
+++ b/docs/helper-methods.md
@@ -0,0 +1,68 @@
+
+# Helper Methods
+
+Helper methods are methods that are used to help you with some common tasks. They are not chainable. They are not required to use the frame methods.
+
+### `range()`
+
+`range()` is a helper method that is used to create a an array of numbers. Here are the arguments and their default values:
+
+| Argument | Description                                                   | Default Value |
+| -------- | ------------------------------------------------------------- | ------------- |
+| `start`  | The start of the range                                        | Required      |
+| `end`    | The end of the range                                          | Required      |
+| `step`   | The step size of the range                                    | 1             |
+| `remove` | An array of numbers which should not be included in the range | `undefined`   |
+
+> Note: The `step` and `remove` arguments are optional. If you do not provide it, `step` will be set to 1 and `remove` will be set to `undefined`.
+
+#### Example
+
+```js
+range(0, 10);
+// [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+
+range(0, 10, 2);
+// [0, 2, 4, 6, 8, 10]
+
+range(0, 10, 1, [1, 3, 5, 7, 9]);
+// [0, 2, 4, 6, 8, 10]
+```
+
+#### Example with frame
+
+```js
+// Import Frame and range
+import { Frame, range } from 'izuku';
+
+// create a frame
+const frame = new Frame([[...], [...], ...]);
+
+// Get all columns from 2 to 6
+const columns = frame.column(range(2, 6));
+```
+
+### `flattenJSON()`
+
+`flattenJSON()` is a helper method that is used to flatten a JSON object. Here are the arguments and their default values:
+
+| Argument | Description                                                   | Default Value |
+| -------- | ------------------------------------------------------------- | ------------- |
+| `json`   | The JSON object to flatten                                   | Required      |
+
+#### Example
+
+```js
+import { flattenJSON } from 'izuku';
+const flattened = flattenJSON({
+  a: {
+    b: {
+      c: 'hello'
+    }
+  }
+});
+
+// flattened is [ a.b.c: 'hello' ]
+```
+
+In order to see how to chain methods, take a look at the [Chaining Methods](../chaining-methods) section.
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..b91d740
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,64 @@
+# Welcome
+
+<p align="center">
+  <img width="100%" src="https://github.com/luciferreeves/izuku.js/raw/main/render/Izuku.png">
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/github/workflow/status/luciferreeves/izuku.js/Node.js%20CI"> <img src="https://img.shields.io/github/license/luciferreeves/izuku.js"> <img src="https://img.shields.io/github/issues-raw/luciferreeves/izuku.js">
+</p>
+
+## About Izuku
+
+Izuku is a simple, fast, and powerful tabular data representation and manipulation library written in [TypeScript](https://www.typescriptlang.org/). It is designed to be used to view, manipulate and debug 2D data in NodeJS applications.
+
+The core of Izuku is the `Frame` class that represents a 2D array of data. It is designed to be used as a data structure for tabular data. Izuku is heavily inspired by [Pandas](https://pandas.pydata.org/).
+
+**Note**: Izuku is not a replacement for Pandas and should not be used for data analysis. It is designed to be used for data visualization and debugging. It can, however, handle large datasets and help you understand your data better but comes at some cost in performance. Since, Pandas is based on NumPy, and NumPy is written in C, Pandas would be much faster than Izuku.
+
+To get started, read the [Getting Started](getting-started) section.
+
+## Cloning and Building Izuku
+
+Cloning and Building is helpful for local development. You can clone Izuku from the [GitHub repository](https://github.com/luciferreeves/izuku.js). To build Izuku, you will need to install the [TypeScript compiler](https://www.typescriptlang.org/). To clone the repository, run the following command in your terminal:
+
+```bash
+git clone https://github.com/luciferreeves/izuku.js.git
+```
+
+Change into the directory and run the following command to install dependencies:
+
+```bash
+npm install
+```
+
+To build Izuku, run the following command:
+
+```bash
+npm run build
+```
+
+To run tests, run the following command:
+
+```bash
+npm test
+```
+
+## Contributing
+
+You can contribute to Izuku by making a pull request on the [GitHub repository](https://github.com/luciferreeves/izuku.js). Take a look at the [CONTRIBUTING.md](https://github.com/luciferreeves/izuku.js/blob/main/CONTRIBUTING.md) file for more information on how to contribute.
+
+## Code of Conduct
+
+You can view the [Code of Conduct](https://github.com/luciferreeves/izuku.js/blob/main/CODE_OF_CONDUCT.md) for Izuku. Code of Conduct is a pledge to conduct yourself in a manner that is respectful to the community. It is also a guideline for how to behave in the community. Here's an extract from [Code of Conduct](https://github.com/luciferreeves/izuku.js/blob/main/CODE_OF_CONDUCT.md):
+
+> We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+>
+> We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+
+
+## Licensing
+
+Any contributions you make will be under the MIT License. In short, when you submit code changes, your submissions are understood to be under the same [MIT License](https://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
+
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 0000000..a22d9b7
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,35 @@
+site_name: Izuku Documentation
+theme:
+  name: material
+  favicon: assets/logo.png
+  icon:
+    repo: fontawesome/brands/github
+  features:
+    - navigation.expand
+    - navigation.top
+    - toc.integrate
+copyright: Copyright &copy; 2022 Izuku. Licensed under the MIT License.
+repo_url: https://github.com/luciferreeves/izuku.js
+repo_name: luciferreeves/izuku.js
+edit_uri: edit/master/docs/
+plugins:
+  - git-revision-date
+  - search
+extra:
+  generator: false
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+      use_pygments: true
+  - pymdownx.inlinehilite
+  - pymdownx.superfences 
+nav:
+  - Home: index.md
+  - Getting Started: getting-started.md
+  - Frame Properties: frame-properties.md
+  - Frame Methods: frame-methods.md
+  - Helper Methods: helper-methods.md
+  - Chaining Methods: chaining-methods.md
+
+    
+  
diff --git a/package.json b/package.json
index ffcc5f9..6411e93 100644
--- a/package.json
+++ b/package.json
@@ -13,7 +13,8 @@
     "build": "rm -rf dist && rimraf ./build && tsc",
     "lint": "eslint . --ext .ts",
     "format": "prettier --config .prettierrc 'src/**/*.ts' --write",
-    "test-single": "func() { env TS_NODE_COMPILER_OPTIONS='{\"module\": \"commonjs\", \"resolveJsonModule\": true }' mocha -r ts-node/register \"$1\"; }; func"
+    "test-single": "func() { env TS_NODE_COMPILER_OPTIONS='{\"module\": \"commonjs\", \"resolveJsonModule\": true }' mocha -r ts-node/register \"$1\"; }; func",
+    "docs:dev": "mkdocs serve"
   },
   "repository": {
     "type": "git",