README.md

Dataverse Data Explorer

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. 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.

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.

Installation

Pre-Requisites

• NodeJS (runtime for Angular and client)

  For development, I recommend using a Node Version manager such as nvm or fnm. Otherwise, NodeJS can be found here.

• Angular (client framework)

  npm install -g @angular/cli

Now to start development.

npm install
ng serve

Customization

Dataverse Instance Name

You can customize the dataverse instance name in the en.json.

Building

Into Dataverse Instance

Integrating Data Explorer in your institution? See the Dataverse guide for more information about installing external tools.

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

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