Web Codebook

Overview

The web codebook is a JavaScript library that provides a concise summary of every variable in a dataset. The codebook includes interactive features such as real-time filters and requires minimal user configuration. Click here for a live demo. When the page loads, the user sees a "codebook" providing a graphical data summary for each data column.

Background

The web-codebook is inspired Frank Harrell's excellent summarize method from the Hmisc R package. summarize creates concise data summaries with minimal user configuration. Further, Agustin Calatroni and Shane Rosanbalm have created SAS data summary methods at Rho in recent years. Our goal here is to create a web-based data summary that uses the same general principles (concise data display, minimal configuration), but with added interactivity (filters, paneled displays, data listings) that is not possible in the static displays created by Hmisc or in SAS.

Typical Usage

Generally speaking, no configuration is needed to create a web-codebook. Just load a JSON data set and the tool will automatically create a user interface (filters, etc.) based on the data set loaded. Initialize the chart like so:

webcodebook.createChart('#chartLocation', {}).init(data);

See the API and Configuration pages for more details about custom configurations.

Links

• Interactive Example
• Configuration
• API
• Technical Documentation
• Data Guidelines