Visualization & dashboards
Quilt packages are not only reproducible units of data and metadata, but units of reporting. You can use the following features to include interactive visualizations and light applications inside of packages.
Importantly, relative references to data are resolved relative to the parent package. This means that all of your reports are backed by immutable, versioned data, providing a common frame of reference that is lacking in BI applications that read from fast-moving databases and file systems.
In addition to rendering a wide variety of images, binary files, and text files, the Quilt catalog supports Vega, Vega-lite, ECharts, and Voila (Developer preview). This gives you access to hundreds of charts out of the box.
quilt_summarize.json
quilt_summarize.json
quilt_summarize.json
is a configuration file that renders one or more dashboard elements in both Bucket view and Packages view. The contents of quilt_summarize.json
are a JSON array of files that you wish to preview in the catalog. Each file may be represented as a string or, if you wish to provide more configuration, as an object.
The simplest summary is a list of relative paths to files that you wish to preview:
By default, each list element renders in its own row.
For multi-column layouts, you can provide an array instead of a string for a given row:
Each element of an array in quilt_summarize.json
can either be a path string or an object with one or more of the following properties:
path
- file path relative toquilt_summarize.json
title
- title rendered instead of file pathdescription
- description in markdown formatwidth
- column width either in pixels or ratio (default is ratio1
)types
- a list of rendering types; currently only singleton list values are supported:["echarts"]
to render JSON as an EChart["voila"]
to render a Jupyter notebook as an interactive Voila dashboard
If you need to control the height of an element (useful for Voila dashboards), use the following extended syntax:
At present height
is the only supported style
element.
Vega and Vega-lite
The Quilt catalog uses vega-embed, vega, and vega-lite. See package.json for specific library versions and compatibility.
In order to display a Vega or Vega-Lite visualization, simply reference a JSON file with a library-compatible schema in a JSON file as follows in your quilt_summarize.json
file:
For both Vega and Vega Lite you may specify relative paths to package files as data sources and the Quilt catalog will resolve the same.
Altair
The easiest way to create Vega-lite visualizations for Quilt packages is with Altair.
Here's a simple example:
ECharts
To render an EChart, you provide a JSON file (a dictionary that specifies the ECharts option parameter) and you set the "types"
property to [ "echarts" ]
.
Example
The following example is a simple line chart from the ECharts documentation.
External files
As with Vega, you can provide either a relative path or URL to the dataset file.
Relative paths are resolved relative to your echarts.json file and relative to the parent package.
Limitations
At present, ECharts in Quilt does not support custom JavaScript. You are therefore limited to JSON types (numbers, strings, objects, arrays, etc.). Functions like symbolSize
are not available.
Voila
This feature is a Developer preview, details are subject to change.
Enterprise deployments of Quilt support interactive Jupyter notebooks with Voilà.
In brief, a Voila dashboard version of your notebook will display all of the output cells and none of the input cells from the underlying notebook. This enables you to create interactive, Jupyter-driven apps for your Quilt catalog users.
The Voila libraries execute a remote Jupyter Kernel and stream the results to the browser with tornado. Jupyter kernels run on a single EC2 instance (t3.small
by default) in Linux containers that have network access but do not have access to persistent storage. The catalog users's AWS credentials are passed to Jupyter kernel as environment variables.
Environment variables
When you have a Voila dashboard inside of a Quilt package, you may wish to reference files in the current package revision. The Quilt catalog sets the following environment variables and passes them to the Voila kernel:
QUILT_PKG_BUCKET
QUILT_PKG_NAME
QUILT_PKG_TOP_HASH
You can access these variables in Python and browse the package:
Included Python packages
By default, Quilt Voila containers provide the following modules:
Last updated