js-neutron-frame

Table of Contents

1. About The Project
2. Getting Started
3. Documentation and Examples
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

"js-neutron-frame" is a powerful library written in TypeScript designed to provide data manipulation and statistical analysis capabilities, akin to Python's Pandas library, but tailored specifically for JavaScript/TypeScript and Node.js applications. The library offers a flexible and efficient way to work with tabular data, enabling developers to perform data transformations, statistical calculations, and more, all within the JavaScript ecosystem.

Key Features:

Data Manipulation: With "js-neutron-frame", you can effortlessly work with data in tabular format, treating it like a spreadsheet. The library supports adding, updating, and deleting rows and columns, making data manipulation a breeze.

Statistical Analysis: "js-neutron-frame" comes equipped with a rich set of statistical functions. Perform operations such as calculating mean, median, mode, and standard deviation on columns or the entire DataFrame, gaining valuable insights from your data.

Data Import and Export: Easily import data from CSV and Excel files, ensuring seamless integration with your existing datasets. The library empowers you to export results and processed data back to various file formats with ease.

Dynamic Column Handling: When using the addRow function, "DataFrame.js" dynamically adjusts columns based on the provided data. New columns are automatically created if the keys in the provided row data do not exist in the current columns.

Flexible and Lightweight: Built with modern JavaScript, "DataFrame.js" offers a lightweight and versatile solution for data analysis. It is optimized for speed and memory efficiency, making it suitable for both small and large datasets.

Easy Integration: As an npm module, "DataFrame.js" is readily available for integration into any JavaScript or Node.js project. Simply install the package and start harnessing its data manipulation capabilities right away.

(back to top)

Getting Started

This is walkthrough of how the library can be installed/

Prerequisites and Installation

1. Install Node.js and npm
2. For TypeScript projects, install TypeScript [This step is not required for JavaScript projects]

npm install typescript --save-dev

3. Install the library from npm modules:

npm install js-neutron-frame

(back to top)

Documentation and Examples

import the library

import { DataFrame, readCSV } from "js-neutron-frame";

Create DataFrame

1. Create an empty DataFrame:

const df = new DataFrame();

---

2. Create DataFrame by reading from .csv file:

const df = await readCSV('./oscar_age_male.csv');

---

DataFrame utilities

3. addRows(DataFrameRow): void The keys refer to the columns If a key is new, it is added to the columns

df.addRow({Index:1, Year: 1928, Age:44, Name:'Emil Jannings', Movie: 'The Last Command'});
df.addRow({Index:2, Year: 1929, Age:41, Name:'Warner Baxter', Movie: 'The Old Arizona'});
df.addRow({Index:3, Year: 1930, Age:62, Name:'George Arliss', Movie: 'Disraeli'});
df.addRow({Index:4, Year: 1931, Age:53, Name:'Lionel Barrymore', Movie: 'A Free Soul'});

---

4. addColumns(name: string, values: (number | string | boolean)[]): void

const BoxOffice = [50000, 60000, 75000];
df.addColumn('BoxOffice', salaryData);

---

5. getShape(): [row_size, column_size] returns the [rows, columns] of the DataFrame

df.getShape();

Output: [ 89, 5 ]

---

6. filterByColums(columnName: string, value: number | string | boolean): DataFrameRow[] Takes columnName and the value that has to be matched as input. This does simple plain matching and returns the filtered rows.

df.filterByColumn('Age', 44)

Output:

[
  {
    Index: 1,
    Year: 1928,
    Age: 44,
    Name: 'Emil Jannings',
    Movie: 'The Last Command'
  },
  {
    Index: 87,
    Year: 2014,
    Age: 44,
    Name: 'Matthew McConaughey',
    Movie: 'Dallas Buyers Club'
  }
]

---

7. showFirstRows(n: number = 5): DataFrameRow[] Shows n rows from beggining. Default 5 rows are shown if not specified.

const firstRows = df.showFirstRows(3);

Output:

[
  {
    Index: 1,
    Year: 1928,
    Age: 44,
    Name: 'Emil Jannings',
    Movie: 'The Last Command'
  },
  {
    Index: 2,
    Year: 1929,
    Age: 41,
    Name: 'Warner Baxter',
    Movie: 'In Old Arizona'
  },
  {
    Index: 3,
    Year: 1930,
    Age: 62,
    Name: 'George Arliss',
    Movie: 'Disraeli'
  }
]

---

8. showLastRows(n: number = 5): DataFrameRow[] Shows n rows from last. Default 5 rows are shown if not specified.

const lastRows = df.showLastRows(2)

Output:

[
  {
    Index: 3,
    Year: 1930,
    Age: 62,
    Name: 'George Arliss',
    Movie: 'Disraeli'
  },
  {
    Index: 4,
    Year: 1931,
    Age: 53,
    Name: 'Lionel Barrymore',
    Movie: 'A Free Soul'
  }
]

---

9. getColumnDataTypes(): { [key: string]: string } returns the data types of the columns based on their values

df.getColumnDataTypes();

Output:

{
  Index: 'number',
  Year: 'number',
  Age: 'number',
  Name: 'string',
  Movie: 'string'
}

Statistical Opeartions on the Data

For more examples, please refer to the google doc Documentation

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Krishna Rao - @KrishnaRaoBV - [e-mail]

Project Link: https://github.com/krishnaatt/js-neutron-frame

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• Choose an Open Source License
• GitHub Emoji Cheat Sheet
• Img Shields

(back to top)