Skip to content

Latest commit

 

History

History
484 lines (389 loc) · 11.7 KB

README.md

File metadata and controls

484 lines (389 loc) · 11.7 KB
Raw

epiviz.gl

The epiviz.gl project is meant to visualize genomic data using webgl and webworkers, in an effort to give a fluid, high-performance user experience. Visualizations are defined via a declarative specification.

Live demo: https://epiviz.github.io/epiviz.gl/

Install

Package is published to npm registry @ https://www.npmjs.com/package/epiviz.gl

$ yarn add epiviz.gl

or through npm

$ npm install --save epiviz.gl

Usage

See app/index.js for a more comprehensive example.

import WebGLVis from "epiviz.gl";

const container = document.createElement("div");

const visualization = new WebGLVis(container);
visualization.addToDom();
visualization.setSpecification({
  defaultData: ["day,price", "1,10", "2,22", "3,35"],
  tracks: [
    {
      mark: "line",
      x: {
        attribute: "day",
        type: "quantitative",
        domain: [1, 10],
      },
      y: {
        attribute: "price",
        type: "quantitative",
        domain: [0, 40],
      },
      color: {
        value: "red",
      },
    },
  ],
});

Features

Zooming and Panning:

All visualizations automatically include zooming and panning:

zooming and panning

Selection:

All visualizations also include an ability to box or lasso select:

selection

Unidirectional Selection:

For box-selections, epiviz.gl supports unidirectional selection in the plot, which restricts the selection to occur either horizontally or vertically based on mouse movement. This enhances box selection by allowing the user to select a region in a single direction. It is disabled by default and can be enabled by using the setViewOptions function.

plot.setViewOptions({
  uniDirectionalSelectionEnabled: true,
}); // enables unidirectional selection
plot.setViewOptions({
  uniDirectionalSelectionEnabled: false,
}); // disables unidirectional selection

By setting the argument to true, the unidirectional selection will be enabled. Setting it to false will disable this feature.

Graph Zoom Control

The enhanced graph visualization tool now offers refined zoom controls, ensuring a precise and adaptable data representation. You can now set max zoom level allowed in the graph using the setViewOptions function.

setViewOptions({
  maxZoomLevel: 0,
});

SVG Options

You can now specify the SVG options for the visualization using the setSVGOptions function. Default value is

{
  svgStyle: {
    width: "100%",
    height: "100%",
    position: "absolute",
    pointerEvents: "none",
    overflow: "visible",
  },
  selectionMarkerAttributes: {
    fill: "rgba(124, 124, 247, 0.3)",
    stroke: "rgb(136, 128, 247)",
    "stroke-width": "1",
    "stroke-dasharray": "5,5",
  },
}

It supports the following options:

  • svgStyle: An object containing the style attributes for the SVG element.
  • selectionMarkerAttributes: An object containing the style attributes for the selection marker.

Zoom Control Direction

You can now specify to use natural scrolling or inverted scrolling for zooming in and out using the setViewOptions function. Default value is true.

setViewOptions({
  useNaturalScrolling: false,
});

Specifications

Documentation for specifications can be found in docs/specification_doc.md. Documentation for the specifications can be generated with json-schema-for-humans:

cd src/epiviz.gl/specification-validation
generate-schema-doc visualization.json --config template_name=md

Examples

Scatterplot

Specification:

{
  "xAxis": "center",
  "yAxis": "center",
  "defaultData": "path/to/tsne.csv",
  "tracks": [
    {
      "mark": "point",
      "x": {
        "attribute": "x",
        "type": "quantitative",
        "domain": [-10, 10]
      },
      "y": {
        "attribute": "y",
        "type": "quantitative",
        "domain": [-10, 10]
      },
      "color": {
        "attribute": "sample",
        "type": "categorical",
        "cardinality": 32,
        "colorScheme": "interpolateRainbow"
      },
      "opacity": { "value": 0.05 }
    }
  ]
}

selection

Box Track

Specification:

{
  "margins": {
    "left": "10%"
  },
  "labels": [
    {
      "y": 0.05,
      "x": -1.3,
      "text": "Box 1",
      "fixedX": true
    }
  ],
  "xAxis": "zero",
  "yAxis": "none",
  "defaultData": "path/to/box-track.csv",
  "tracks": [
    {
      "tooltips": 1,
      "mark": "rect",
      "layout": "linear",
      "x": {
        "type": "genomicRange",
        "chrAttribute": "chr",
        "startAttribute": "start",
        "endAttribute": "end",
        "domain": ["chr2:3049800", "chr2:9001000"],
        "genome": "hg38"
      },
      "y": {
        "value": 0
      },
      "height": {
        "value": 10
      },
      "color": {
        "type": "quantitative",
        "attribute": "score",
        "domain": [0, 8],
        "colorScheme": "interpolateBlues"
      }
    }
  ]
}

selection

Line Track

Specification:

{
  "defaultData": "path/to/box-track.csv",
  "tracks": [
    {
      "tooltips": 1,
      "mark": "line",
      "layout": "linear",
      "x": {
        "type": "genomic",
        "chrAttribute": "chr",
        "geneAttribute": "start",
        "domain": ["chr2:3049800", "chr2:9001000"],
        "genome": "hg38"
      },
      "y": {
        "type": "quantitative",
        "attribute": "score",
        "domain": [0, 10],
        "colorScheme": "interpolateBlues"
      },
      "color": {
        "type": "quantitative",
        "attribute": "score",
        "domain": [0, 8],
        "colorScheme": "interpolateBlues"
      }
    }
  ]
}

selection

Arc Track

Specification:

{
  "xAxis": "zero",
  "yAxis": "none",
  "defaultData": "path/to/arcs.csv",
  "tracks": [
    {
      "mark": "rect",
      "x": {
        "type": "genomicRange",
        "chrAttribute": "region1Chrom",
        "startAttribute": "region1Start",
        "endAttribute": "regionEnd",
        "domain": ["chr2:46000", "chr2:243149000"],
        "genome": "hg19"
      },
      "y": {
        "value": 0
      },
      "height": {
        "value": 10
      },
      "color": {
        "type": "quantitative",
        "attribute": "value",
        "domain": [0, 60],
        "colorScheme": "interpolateBlues"
      },
      "opacity": {
        "value": 0.25
      }
    },
    {
      "mark": "rect",
      "x": {
        "type": "genomicRange",
        "chrAttribute": "region2Chrom",
        "startAttribute": "region2Start",
        "endAttribute": "region2End",
        "domain": ["chr2:38000", "chr2:243149000"],
        "genome": "hg19"
      },
      "y": {
        "value": 0
      },
      "height": {
        "value": 10
      },
      "color": {
        "type": "quantitative",
        "attribute": "value",
        "domain": [0, 60],
        "colorScheme": "interpolateReds"
      },
      "opacity": {
        "value": 0.25
      }
    },
    {
      "mark": "arc",
      "x": {
        "type": "genomicRange",
        "chrAttribute": "region1Chrom",
        "startAttribute": "region1Start",
        "endAttribute": "regionEnd",
        "domain": ["chr2:38000", "chr2:243149000"],
        "genome": "hg19"
      },
      "width": {
        "type": "genomicRange",
        "chrAttribute": "region2Chrom",
        "startAttribute": "region2Start",
        "endAttribute": "region2End",
        "domain": ["chr2:38000", "chr2:243149000"],
        "genome": "hg19"
      },
      "y": {
        "value": 0.1
      },
      "height": {
        "value": 0
      },
      "color": {
        "type": "quantitative",
        "attribute": "value",
        "domain": [0, 60],
        "colorScheme": "interpolateBuGn"
      }
    }
  ]
}

selection

Development

Prepare the repository

yarn install
yarn build

Use the app

yarn start

Then navigate to localhost:1234

Build the package

yarn build-package

Be sure to commit the dist folder if changes made should be distributed.

Deploy to Github Pages

yarn deploy

Run the tests

yarn start

Via command line:

npx cypress run

Via GUI:

npx cypress open

This will open an additional window, where tests can be run on a live version of chrome.

Record the tests

A method of doing of integration tests is to record the state of the application when it is working properly. Then, after making changes, compare the current state of the app and assert the state is equivalent. If it is not equivalent, either something is broken OR it is an anticipated change in which case it is justified to rerecord the tests and commit the change.

Check if current state matches recordings:

npx cypress run --spec "cypress/integration/expected-images.spec.js"

Rerecord the tests:

npx cypress run --spec "cypress/integration/record-tests.spec.js" --env recording=true

Development Notes

Rasterization

Essentially, the project works by building all of the vertices for a visualization upfront. When visualizing data at a large scale, this can cause some vertices and their primitives (triangles, points, lines) to be VERY small which may cause them to not rasterize (be displayed) consistently. This is most apparent when flickering occurs by zooming/panning on genomic tracks or on a large matrix. This problem has been partially solved via the SemanticZoomer, which will render rects in a box track as lines and then as actual rectangles (in the form of two triangles) when zoomed in sufficiently. Altogether, this paragraph is mostly written to recommend developers to consult the OpenGL ES 3 Specification when encountering these issues, particularly Chapter 3 (Rasterization) to gain some insight on how some vertices will be rendered.

Adding an Example

  1. Either add a .csv file to app/examples/data or specify inline data.
  2. Create an example in app/examples/ which should follow this template:
import yourData from "url:./data/your-data-if-you-put-it-here.csv";

export default JSON.stringify(
  {
    defaultData: yourData, // or inline data
    tracks: [
      ...
    ],
  },
  null,
  2
);
  1. In app/index.html add an option to the <select> element:
<option value="your-example">Your Example</option>
  1. In app/scripts/toolbar import your example and add an entry to the exampleMap:
import yourExample from "../examples/your-example";

const exampleMap = new Map([
  ...["your-example", yourExample], // first element is the value attribute from the <option> element
]);
  1. If you feel that your example is instructive of some functionality of the library and would be worth becoming an integration test, go to cypress/support/index.js and add the value attribute from the <option> element to allPresetNames.

If your example is particularly long to render due to many vertices or a large amount of data, consider adding it to the longPresets array.

  1. If you completed step 5, rerecord the tests, but be sure to only commit only the test-image from your example (provided it is correct).