danfojs Documentation

Technical Documentation: javascriptdata/danfojs

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`README.md`)

Danfojs: powerful javascript data analysis toolkit

What is it?

Danfo.js is a javascript package that provides fast, flexible, and expressive data
structures designed to make working with "relational" or "labeled" data both
easy and intuitive. It is heavily inspired by Pandas library, and provides a similar API. This means that users familiar with Pandas, can easily pick up danfo.js.

Main Features

Danfo.js is fast and supports Tensorflow.js tensors out of the box. This means you can convert Danfo data structure to Tensors.
Easy handling of missing-data (represented as
NaN) in floating point as well as non-floating point data
Size mutability: columns can be inserted/deleted from DataFrame
Automatic and explicit alignment: objects can
be explicitly aligned to a set of labels, or the user can simply
ignore the labels and let Series, DataFrame, etc. automatically
align the data for you in computations
Powerful, flexible groupby functionality to perform
split-apply-combine operations on data sets, for both aggregating
and transforming data
Make it easy to convert Arrays, JSONs, List or Objects, Tensors and
differently-indexed data structures
into DataFrame objects
Intelligent label-based slicing, fancy indexing, and querying of
large data sets
Intuitive merging and joining data
sets
Robust IO tools for loading data from flat-files
(CSV, Json, Excel).
Powerful, flexible and intutive API for plotting DataFrames and Series interactively.
Timeseries-specific functionality: date range
generation and date and time properties.
Robust data preprocessing functions like OneHotEncoders, LabelEncoders, and scalers like StandardScaler and MinMaxScaler are supported on DataFrame and Series

Installation

There are three ways to install and use Danfo.js in your application

For Nodejs applications, you can install the danfojs-node version via package managers like yarn and/or npm:

bash

npm install danfojs-node

or

yarn add danfojs-node

For client-side applications built with frameworks like React, Vue, Next.js, etc, you can install the danfojs version:

bash

npm install danfojs

or

yarn add danfojs

For use directly in HTML files, you can add the latest script tag from JsDelivr to your HTML file:

html

<script src="https://cdn.jsdelivr.net/npm/[email protected]/lib/bundle.js"></script>

See all available versions here

Quick Examples

Example Usage in the Browser

html

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <script src="https://cdn.jsdelivr.net/npm/[email protected]/lib/bundle.js"></script>

    <title>Document</title>
  </head>

  <body>
    <div id="div1"></div>
    <div id="div2"></div>
    <div id="div3"></div>

    <script>

      dfd.readCSV("https://raw.githubusercontent.com/plotly/datasets/master/finance-charts-apple.csv")
          .then(df => {

              df['AAPL.Open'].plot("div1").box() //makes a box plot

              df.plot("div2").table() //display csv as table

              new_df = df.setIndex({ column: "Date", drop: true }); //resets the index to Date column
              new_df.head().print() //
              new_df.plot("div3").line({
                  config: {
                      columns: ["AAPL.Open", "AAPL.High"]
                  }
              })  //makes a timeseries plot

          }).catch(err => {
              console.log(err);
          })
    </script>
  </body>
</html>

Output in Browser:

Example usage in Nodejs

text

/* Detailed source-code truncated for AI context efficiency. */

Output in Node Console:

Notebook support

VsCode nodejs notebook extension now supports Danfo.js. See guide here
ObservableHQ Notebooks. See example notebook here

[See the Official Getting Started Guide](https://danfo.jsdata.org/getting-started)

Documentation

The official documentation can be found here

Discussion and Development

Development discussions take place here.

Contributing to Danfo

All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. A detailed overview on how to contribute can be found in the contributing guide.

Licence [MIT](https://github.com/opensource9ja/danfojs/blob/master/LICENCE)

Overview (`src/danfojs-base/README.md`)

danfojs-base

danfojs-base is the core module of Danfo.js. Danfojs-node and Danfojs-browser folders simply extends/export this functions and classes from this module.

Folders and Files

aggregators: All files that contain functions that aggregate data.
core: Holds the core classes of Danfo.js.
- daterange: Class that represents a date range.
- datetime: Class that represents a date and time.
- frame: Class that represents a frame.
- series: Class that represents a series.
- generic: Class that represents a generic object.
- indexing: Class that represents an indexing.
- math.ops: Class that represents a math operation.
- strings: Class that represents a string.
io: Holds the IO classes of Danfo.js.
- browser: Holds the browser IO classes.
  - io.csv: Holds the CSV IO classes.
  - io.json: Holds the JSON IO classes.
  - io.excel: Holds the excel IO classes.
- node: Holds the node IO classes for Node.js
  - io.csv: Holds the CSV IO classes for Node.js
  - io.json: Holds the JSON IO classes for Node.js
  - io.excel: Holds the excel IO classes for Node.js
plotting: Holds the plotting classes
- plotly: Holds the plotting class for Plotly charts.
- vega: (Stub) Holds the plotting class for Vega charts.
shared
- config: Holds the configuration class.
- defaults: Holds the default values for the configuration class.
- errors: Holds the error classes.
- tensorflowlib: Autogenerated tensorflow library export.
- utils: Holds the utility classes.
- types: Holds the type classes.
transformers: Holds the transformers files
- encoders: Holds the encoder classes.
  - dummy.encoder: Holds the dummy encoder class
  - one.hot.encoder: Holds the onehot encoder class
  - label.encoder: Holds the label encoder class
- scalers
  - min.max.scalers: Holds the min max scaler class
  - standard.scalers: Holds the standard scaler class
- concat: Holds the concatenation class
- merge: Holds the merge class
index.ts: Entry point for the module.

Overview (`src/danfojs-browser/README.md`)

Danfojs: powerful javascript data analysis toolkit

What is it?

Main Features

Danfo.js is fast. It is built on Tensorflow.js, and supports tensors out of the box. This means you can convert Danfo data structure to Tensors.
Easy handling of missing-data (represented as
NaN) in floating point as well as non-floating point data
Size mutability: columns can be inserted/deleted from DataFrame
Automatic and explicit alignment: objects can
be explicitly aligned to a set of labels, or the user can simply
ignore the labels and let Series, DataFrame, etc. automatically
align the data for you in computations
Powerful, flexible groupby functionality to perform
split-apply-combine operations on data sets, for both aggregating
and transforming data
Make it easy to convert Arrays, JSONs, List or Objects, Tensors and
differently-indexed data structures
into DataFrame objects
Intelligent label-based slicing, fancy indexing, and querying of
large data sets
Intuitive merging and joining data
sets
Robust IO tools for loading data from flat-files
(CSV, Json, Excel, Data package).
Powerful, flexible and intutive API for plotting DataFrames and Series interactively.
Timeseries-specific functionality: date range
generation and date and time properties.
Robust data preprocessing functions like OneHotEncoders, LabelEncoders, and scalers like StandardScaler and MinMaxScaler are supported on DataFrame and Series

Installation

There are three ways to install and use Danfo.js in your application

For Nodejs applications, you can install the danfojs-node version via package managers like yarn and/or npm:

bash

npm install danfojs-node

or

yarn add danfojs-node

For client-side applications built with frameworks like React, Vue, Next.js, etc, you can install the danfojs version:

bash

npm install danfojs

or

yarn add danfojs

For use directly in HTML files, you can add the latest script tag from JsDelivr to your HTML file:

html

<script src="https://cdn.jsdelivr.net/npm/[email protected]/lib/bundle.js"></script>

See all available versions here

Example Usage in the Browser

Run in Code Sandbox

html

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <script src="https://cdn.jsdelivr.net/npm/[email protected]/lib/bundle.js"></script>

    <title>Document</title>
  </head>

  <body>
    <div id="div1"></div>
    <div id="div2"></div>
    <div id="div3"></div>

    <script>

      dfd.readCSV("https://raw.githubusercontent.com/plotly/datasets/master/finance-charts-apple.csv")
          .then(df => {

              df['AAPL.Open'].plot("div1").box() //makes a box plot

              df.plot("div2").table() //display csv as table

              new_df = df.setIndex({ column: "Date", drop: true }); //resets the index to Date column
              new_df.head().print() //
              new_df.plot("div3").line({
                  config: {
                      columns: ["AAPL.Open", "AAPL.High"]
                  }
              })  //makes a timeseries plot

          }).catch(err => {
              console.log(err);
          })
    </script>
  </body>
</html>

Output in Browser:

Example usage in Nodejs

text

/* Detailed source-code truncated for AI context efficiency. */

Output in Node Console:

Notebook support

You can use Danfo.js on Dnotebooks playground here
VsCode nodejs notebook extension now supports Danfo.js. See guide here

[See the Official Getting Started Guide](https://danfo.jsdata.org/getting-started)

Documentation

The official documentation can be found here

Danfo.js Official Book

We recently published a book titled "Building Data Driven Applications with Danfo.js". Read more about it here

Discussion and Development

Development discussions take place here.

Contributing to Danfo

All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. A detailed overview on how to contribute can be found in the contributing guide.

Licence [MIT](https://github.com/opensource9ja/danfojs/blob/master/LICENCE)

Created by [Rising Odegua](https://github.com/risenW) and [Stephen Oni](https://github.com/steveoni)

Overview (`src/danfojs-node/README.md`)

Danfojs: powerful javascript data analysis toolkit

What is it?

Main Features

Danfo.js is fast. It is built on Tensorflow.js, and supports tensors out of the box. This means you can convert Danfo data structure to Tensors.
Easy handling of missing-data (represented as
NaN) in floating point as well as non-floating point data
Size mutability: columns can be inserted/deleted from DataFrame
Automatic and explicit alignment: objects can
be explicitly aligned to a set of labels, or the user can simply
ignore the labels and let Series, DataFrame, etc. automatically
align the data for you in computations
Powerful, flexible groupby functionality to perform
split-apply-combine operations on data sets, for both aggregating
and transforming data
Make it easy to convert Arrays, JSONs, List or Objects, Tensors and
differently-indexed data structures
into DataFrame objects
Intelligent label-based slicing, fancy indexing, and querying of
large data sets
Intuitive merging and joining data
sets
Robust IO tools for loading data from flat-files
(CSV, Json, Excel, Data package).
Powerful, flexible and intutive API for plotting DataFrames and Series interactively.
Timeseries-specific functionality: date range
generation and date and time properties.
Robust data preprocessing functions like OneHotEncoders, LabelEncoders, and scalers like StandardScaler and MinMaxScaler are supported on DataFrame and Series

Installation

There are three ways to install and use Danfo.js in your application

For Nodejs applications, you can install the danfojs-node version via package managers like yarn and/or npm:

bash

npm install danfojs-node

or

yarn add danfojs-node

For client-side applications built with frameworks like React, Vue, Next.js, etc, you can install the danfojs version:

bash

npm install danfojs

or

yarn add danfojs

For use directly in HTML files, you can add the latest script tag from JsDelivr to your HTML file:

html

<script src="https://cdn.jsdelivr.net/npm/[email protected]/lib/bundle.js"></script>

See all available versions here

Example Usage in the Browser

Run in Code Sandbox

html

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <script src="https://cdn.jsdelivr.net/npm/[email protected]/lib/bundle.js"></script>

    <title>Document</title>
  </head>

  <body>
    <div id="div1"></div>
    <div id="div2"></div>
    <div id="div3"></div>

    <script>

      dfd.readCSV("https://raw.githubusercontent.com/plotly/datasets/master/finance-charts-apple.csv")
          .then(df => {

              df['AAPL.Open'].plot("div1").box() //makes a box plot

              df.plot("div2").table() //display csv as table

              new_df = df.setIndex({ column: "Date", drop: true }); //resets the index to Date column
              new_df.head().print() //
              new_df.plot("div3").line({
                  config: {
                      columns: ["AAPL.Open", "AAPL.High"]
                  }
              })  //makes a timeseries plot

          }).catch(err => {
              console.log(err);
          })
    </script>
  </body>
</html>

Output in Browser:

Example usage in Nodejs

text

/* Detailed source-code truncated for AI context efficiency. */

Output in Node Console:

Notebook support

You can use Danfo.js on Dnotebooks playground here
VsCode nodejs notebook extension now supports Danfo.js. See guide here

[See the Official Getting Started Guide](https://danfo.jsdata.org/getting-started)

Documentation

The official documentation can be found here

Danfo.js Official Book

We recently published a book titled "Building Data Driven Applications with Danfo.js". Read more about it here

Discussion and Development

Development discussions take place here.

Contributing to Danfo

All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. A detailed overview on how to contribute can be found in the contributing guide.

Licence [MIT](https://github.com/opensource9ja/danfojs/blob/master/LICENCE)

Created by [Rising Odegua](https://github.com/risenW) and [Stephen Oni](https://github.com/steveoni)

--- METRICS ---

Files Extracted: 4
Estimated Token Budget: ~6027 tokens
Canonical Reference: https://codewiki.google/github.com/javascriptdata/danfojs

Technical Documentation: javascriptdata/danfojs

Overview (`README.md`) Copy Section

Danfojs: powerful javascript data analysis toolkit Copy Chapter

What is it? Copy Chapter

Main Features Copy Chapter

Installation Copy Chapter

Quick Examples Copy Section

Example Usage in the Browser Copy Section

Example usage in Nodejs Copy Section

Notebook support Copy Chapter

[See the Official Getting Started Guide](https://danfo.jsdata.org/getting-started)

Documentation Copy Chapter

Discussion and Development Copy Chapter

Contributing to Danfo Copy Chapter

Licence [MIT](https://github.com/opensource9ja/danfojs/blob/master/LICENCE)

Overview (`src/danfojs-base/README.md`) Copy Section

danfojs-base Copy Chapter

Folders and Files Copy Chapter

Overview (`src/danfojs-browser/README.md`) Copy Section

Danfojs: powerful javascript data analysis toolkit Copy Chapter

What is it? Copy Chapter

Main Features Copy Chapter

Installation Copy Chapter

Example Usage in the Browser Copy Section

Example usage in Nodejs Copy Section

Notebook support Copy Chapter

[See the Official Getting Started Guide](https://danfo.jsdata.org/getting-started)

Documentation Copy Chapter

Danfo.js Official Book Copy Chapter

Discussion and Development Copy Chapter

Contributing to Danfo Copy Chapter

Licence [MIT](https://github.com/opensource9ja/danfojs/blob/master/LICENCE)

Created by [Rising Odegua](https://github.com/risenW) and [Stephen Oni](https://github.com/steveoni)

Overview (`src/danfojs-node/README.md`) Copy Section

Danfojs: powerful javascript data analysis toolkit Copy Chapter

What is it? Copy Chapter

Main Features Copy Chapter

Installation Copy Chapter

Example Usage in the Browser Copy Section

Example usage in Nodejs Copy Section

Notebook support Copy Chapter

[See the Official Getting Started Guide](https://danfo.jsdata.org/getting-started)

Documentation Copy Chapter

Danfo.js Official Book Copy Chapter

Discussion and Development Copy Chapter

Contributing to Danfo Copy Chapter

Licence [MIT](https://github.com/opensource9ja/danfojs/blob/master/LICENCE)

Created by [Rising Odegua](https://github.com/risenW) and [Stephen Oni](https://github.com/steveoni)

Explore Related Technologies & Topics

Overview (`README.md`)

Danfojs: powerful javascript data analysis toolkit

What is it?

Main Features

Installation

Quick Examples

Example Usage in the Browser

Example usage in Nodejs

Notebook support

Documentation

Discussion and Development

Contributing to Danfo

Overview (`src/danfojs-base/README.md`)

danfojs-base

Folders and Files

Overview (`src/danfojs-browser/README.md`)

Danfojs: powerful javascript data analysis toolkit

What is it?

Main Features

Installation

Example Usage in the Browser

Example usage in Nodejs

Notebook support

Documentation

Danfo.js Official Book

Discussion and Development

Contributing to Danfo

Overview (`src/danfojs-node/README.md`)

Danfojs: powerful javascript data analysis toolkit

What is it?

Main Features

Installation

Example Usage in the Browser

Example usage in Nodejs

Notebook support

Documentation

Danfo.js Official Book

Discussion and Development

Contributing to Danfo