# phovea_clue

CLUE (for Capture, Label, Understand, Explain) is a model that tightly integrates data exploration and presentation of discoveries. Based on provenance data captured during the exploration process, users can extract key steps, add annotations, and author 'Vistories', visual stories based on the history of the exploration.

Further resources:

- Vistories.org
- Project Homepage
- Examples using CLUE: StratomeX and Gapminder

## Installation

    git clone https://github.com/phovea/phovea_clue.git
    cd phovea_clue
    npm install

## Testing

    npm test

## Building

    npm run build

## Usage

The most important module is `template.ts` providing a wrapper for an application to include CLUE. See Caleydo/clue_dummy for an simple example how to use it.

This repository is part of Phovea, a platform for developing web-based visualization applications. For tutorials, API docs, and more information about the build and deployment process, see the documentation page.

## Index

### External modules

- "ACLUEWrapper"
- "CLUEGraphManager"
- "annotation"
- "compress"
- "dummy"
- "embed"
- "internal"
- "menu/LoginMenu"
- "menu/ProvenanceGraphMenu"
- "mode"
- "multiform"
- "player"
- "provvis"
- "selection"
- "storyvis"
- "template"
- "utils"
- "vis_loader"

Generated using TypeDoc