https://github.com/nteract/data-explorer

The Data Explorer is nteract's automatic visualization tool.
https://github.com/nteract/data-explorer

automatic-viz data-explorer data-viz

Last synced: 3 months ago
JSON representation

The Data Explorer is nteract's automatic visualization tool.

• Host: GitHub
• URL: https://github.com/nteract/data-explorer
• Owner: nteract
• License: bsd-3-clause
• Created: 2020-01-08T16:08:33.000Z (almost 5 years ago)
• Default Branch: next
• Last Pushed: 2023-01-07T13:32:03.000Z (almost 2 years ago)
• Last Synced: 2024-07-29T04:33:39.417Z (3 months ago)
• Topics: automatic-viz, data-explorer, data-viz
• Language: TypeScript
• Homepage: https://data-explorer.nteract.io/
• Size: 5.53 MB
• Stars: 103
• Watchers: 13
• Forks: 12
• Open Issues: 33
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-starred - nteract/data-explorer - The Data Explorer is nteract's automatic visualization tool. (others)

README

        
# nteract Data Explorer

[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/nteract/examples/master?urlpath=%2Fnteract%2Fedit%2Fpython%2Fhappiness.ipynb)

[![Node.js CI](https://github.com/nteract/data-explorer/actions/workflows/node.js.yml/badge.svg)](https://github.com/nteract/data-explorer/actions/workflows/node.js.yml)

[![CodeQL](https://github.com/nteract/data-explorer/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/nteract/data-explorer/actions/workflows/codeql-analysis.yml)

[![npm version](https://badge.fury.io/js/%40nteract%2Fdata-explorer.svg)](https://www.npmjs.com/package/@nteract/data-explorer)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

An automatic data visualization tool.

## [Interactive Documentation](https://data-explorer.nteract.io/)

Explore the [documentation](https://data-explorer.nteract.io/).

![Data Explorer Examples](https://user-images.githubusercontent.com/1863892/55675008-07632e80-5871-11e9-9dac-0a71450faf7b.gif)

## Creating Data Explorer

Read [Elijah Meeks](https://twitter.com/elijah_meeks)'s [post on designing the data explorer](https://blog.nteract.io/designing-the-nteract-data-explorer-f4476d53f897).

## Using the Data Explorer

To use Data Explorer in your project, use the following approach.

```bash

yarn add @nteract/data-explorer

```

Install `react` and `styled-components` if you are not already using them.

```bash

yarn add react styled-components

```

The `data` prop must be a [tabular data resource `application/vnd.dataresource+json`](https://frictionlessdata.io/specs/tabular-data-resource/)

```jsx

// Default import complete with right side toolbar

import DataExplorer from "@nteract/data-explorer";

;

```

Or, with custom `Toolbar` position:

```jsx

// Individual components as named imports

import { DataExplorer, Toolbar, Viz } from "@nteract/data-explorer";

  

  

;

// Toolbar is optional

  

;

```

## How do I contribute to this repo?

If you are interested in contributing to nteract, please read the [contribution guidelines](./CONTRIBUTING.md) for information on how to set up your nteract repo for development, how to update documentation, and how to submit your code changes for review on GitHub.