@veupathdb/eda-workspace-core

Core utilities for creating a VEuPathDB EDA Workspace application.

Usage no npm install needed!

<script type="module">
  import veupathdbEdaWorkspaceCore from 'https://cdn.skypack.dev/@veupathdb/eda-workspace-core';
</script>

README

EDA Workspace Core

Exploratory Data Analysis Workspace Core

Overview

This module contains React utilities that can be used by a React application that uses the EDA Workspace Service. We plan to power both the EDA Workspace Application and the MapVEu Application with this module.

Description

The concept of an Exploratory Data Analysis Workspace is that, for a given study, a person can browse the data collected for that study, and explore relationships therewithin. Study data is broken out into variables which are categorized according to an ontology and accessed by entity type (e.g., participant, observation, etc.).

The two primiary domain objects of the EDA Workspace are Study and Analysis. A Study represents a structured collection of data. An Analysis is a configuration of a subset of that data, and a collection of visualizations for that subset.

Types

The primary types in use by the EDA Workspace are:

  • StudyRecordClass - The WDK RecordClass of a study.
  • StudyRecord - The WDK RecordInstance of a study.
  • StudyMetadata - The EDA record containing information about entity types, and their variables, collected by the study.
  • Analysis - The persisted configuration of an EDA Workspace session. This includes subsetting details and condfiguration of visualizations. (Should this be renamed Session?)

Usage

The following exports can be used to implement an EDA Workspace client:

  • EDAWorkspaceContainer - A React Component that loads the above types.
  • useAnalysis - A React hook that can be used to access and interact with the current state of the workspace session.
  • useStudy - A React hook that can be used to access the study record types defined above.