KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #ai-agents #dsh-plugin #codex #developer-tools #claude-code #windows #desktop-app #typescript #rust #ai-agent #cli

Dataverse-Data-Explorer

★ 27 Open GitHub ↗

A tool for exploring and curating data by adding labels, groups, weights and other details to assist with informed reuse

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Dataverse Data Explorer

[![Data Explorer Deploy](https://github.com/scholarsportal/Dataverse-Data-Curation-Tool/actions/workflows/static.yml/badge.svg)](https://github.com/scholarsportal/Dataverse-Data-Curation-Tool/actions/workflows/static.yml)
[![Lint/Test](https://github.com/scholarsportal/Dataverse-Data-Curation-Tool/actions/workflows/node.js.yml/badge.svg)](https://github.com/scholarsportal/Dataverse-Data-Curation-Tool/actions/workflows/node.js.yml)

![Data Explorer Screenshot](https://github.com/scholarsportal/Dataverse-Data-Curation-Tool/blob/nana-dev/documentation/img/Data%20Explorer%20Screenshot.png?raw=true 'Data Explorer Screenshot')

## 📜 Description

The Data Explorer combines the previous Data Curation Tool and Data Explorer, built for use with the open-source Dataverse data repository. Data Explorer connects to Dataverse repository tabular data files and enables open metadata discovery and exploration of data such as visualizing charts, statistical analysis and cross tabulations, as well as authorized curation and permission controls for editing and curation of variable metadata such as labels, questions, universe, notes, weights, plus. Any DDI compliant metadata can be adapted for use with this tool, and any stand-alone component is built to complement [The Dataverse Project](http://dataverse.org/). The Data Curation tool options, now built into Data Explorer, are integrated into Dataverse for .tab files under the configure button.

Data Explorer is an Angular application.

## 🎉 Features

- 🌍 Connect to Dataverse repositories
- 📊 Visualize data with charts and tables
- 📊 Create cross tabulations
- 📈 Create cross charts
- 📝 Edit variable metadata
- 📝 Import DDI XML for curation workflows

A demo of the tool is available here; note that this Github pages demo is **not recommended for use in a production environment**: [https://scholarsportal.github.io/Dataverse-Data-Explorer/?dfId=127759&siteUrl=https://borealisdata.ca](https://scholarsportal.github.io/Dataverse-Data-Explorer/?siteUrl=https:%2F%2Fdemo.borealisdata.ca&dfId=40226).

## 📦 Prerequisites

- NodeJS (runtime for Angular and client)
- Angular CLI (client framework)

## ⚙️ Installation

1. Clone the repository

```sh
   git clone https://github.com/scholarsportal/Dataverse-Data-Explorer.git
   ```

2. Change to the project directory

```sh
   cd ./Dataverse-Data-Explorer
   ```

3. Install dependencies

```sh
npm install
```

4. Run the development server

```sh
ng serve
```

## 🎨 Customization

### Dataverse Instance Name

You can customize the dataverse instance name in the en.json (make sure to update the other language files as well).

## 📦 Building

### 📦 Into Dataverse Instance

Integrating Data Explorer in your institution? See [the Dataverse guide for more information about installing external tools](http://guides.dataverse.org/en/latest/installation/external-tools.html).

### 🌐 Serve as web app

You can serve the Data Explorer app like you would any other website.
Use `ng build` to get the `dist` directory, and serve the dist directly using Apache, Nginx, or whatever server you use.

> [!NOTE]
> You can also deploy this via docker.

## App State

![Data Explorer State Diagram](https://github.com/scholarsportal/Dataverse-Data-Curation-Tool/assets/44186742/150d423b-b520-41b8-a908-6586d7aa1084)

The tool has a state divided into three distinct state groups.

The XML State is the final DDI file that will be uploaded to Dataverse.

The Dataset State contains information about operations being operated on the dataset (upload and download status), any extra information gained from an API call (variable cross tab data), as well as imported file information.

The UI state represents any UI changes, including any temporary visual changes to the dataset (invalid values in the chart modal).

## Actions

![1. Data Explorer Screenshot with labels showing what triggers an action](https://github.com/scholarsportal/Dataverse-Data-Curation-Tool/assets/44186742/ad32a66e-caab-4c40-894e-8b103f3779a2)

![2. Data Explorer Screenshot with labels showing what triggers an action](https://github.com/scholarsportal/Dataverse-Data-Curation-Tool/assets/44186742/2348e3bb-ed50-4868-9326-d4bc49998665)

![3. Data Explorer Screenshot with labels showing what triggers an action](https://github.com/scholarsportal/Dataverse-Data-Curation-Tool/assets/44186742/74f97864-5673-4959-aacc-68927df80cd5)

![Data Curation Tool Launch Activity Diagram](https://github.com/scholarsportal/Dataverse-Data-Curation-Tool/blob/nana-dev/documentation/img/Init%20Sequence%20Diagram.jpg?raw=true 'Launch Activity Diagram')

![Update Component View Reference](https://github.com/scholarsportal/Dataverse-Data-Curation-Tool/blob/nana-dev/documentation/img/Update%20Component%20View.jpg?raw=true 'Update Component View Reference')

![View Variable](https://github.com/scholarsportal/Dataverse-Data-Curation-Tool/blob/nana-dev/documentation/img/View%20Variable.jpg?raw=true 'View Variable Sequence Diagram')

![Edit Single Variable](https://github.com/scholarsportal/Dataverse-Data-Curation-Tool/blob/nana-dev/documentation/img/Edit%20Single%20Variable.jpg?raw=true 'Edit Single Variable Sequence Diagram')

Dataverse-Data-Explorer

Was this content helpful?

Recent Feedback

Download README