@arranger/servers v0.0.1-0.0.3.0

Documentation

Explore documentation with the Arranger Read the Docs.

Quickstart

Clone, Install, Bootstrap

git clone git@github.com:overture-stack/arranger.git
cd arranger
npm i
npm run bootstrap

# watch modules and rebuild on change
npm run watch

# run tests for all modules
npm test

# run server on :5050
npm run server

# run dashboard on :6060
npm run dashboard

# run portal on :7070
npm run portal

# run storybook on :8080
npm run storybook

• Documentation
• Motivation
• What is a "Data Portal"?
  • Topology
• Roadmap
• Development
• License

Documentation

For in-depth documentation, please see the Arranger Read the Docs: https://arranger.readthedocs.io/en/latest/

Motivation

The Ontario Institute for Cancer Research (OICR) has built two Data Portals:

• International Cancer Genome Consortium (ICGC) Data Portal
• Genomic Data Commons (GDC) Data Portal (joint effort with University of Chicago)

Although they are not identical in architecture, available data or overall purpose, there is tremendous amount of overlap in how they function and how users interact with them, despite being implemented differently. It's no coincidence. The GDC Data Portal was directly influenced by the ICGC Data Portal.

With new projects ahead of us, there is an opportunity to create a framework designed to act as a core library for any given data portal, similar to what Elastic's Kibana accomplishes, but based on the features of our existing portals and the expectation of continuous improvement and domain specific customization. There are many potential benefits:

• Reduce duplicate code
• Ability to fix bugs and add features to many projects at once
• Pool developer resources
• Increase cross-team communication
• Encourage open source contribution

Topology

this is way too simplistic. needs an update

Roadmap

Short Term

• cli tool for bootstrapping new projects

• Provide all necessary modules to implement searching functionality

  • Dynamic GraphQL schema generation
  • API Server (GraphQL endpoint)
  • Query / Aggregation building middleware
  • Response middleware (ie. removing null aggregations)
  • UI Components
    • Aggregations
      • Simple view
      • Advanced View
    • Results Table
    • SQON Display

• Provide editor interface to expose common transformations (similar to the Babel or bodybuilder REPLs)
  • Elasticsearch Mappings -> GraphQL Schema
  • GraphQL Query -> Elasticsearch Queries

Medium Term

• Authentication
• Sets
• Analysis

Long Term

• Kibana Plugin
• Hosted Data Portal generating service

Development

Arranger is a lerna flavored monorepo. The modules exposed by Arranger compose all of the necessary code required to build an application such as the Genomic Data Commons.*

* The GDC contains many features that are out of Arranger's scope