# webcodebook

> Interactive data set summaries

Latest version **1.6.2** (published 2019-10-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install webcodebook
pnpm add webcodebook
yarn add webcodebook
bun add webcodebook
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.6.2 |
| Published | 2019-10-22 |
| First published | 2017-05-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 335.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Rho, Inc. |
| Maintainers | jwildfire, pburnsdata, rhographics, samussiah |
| Keywords | data, summary, interactive, codebook |

## Links

- npm: https://www.npmjs.com/package/webcodebook
- Repository: https://github.com/rhoinc/web-codebook
- Issues: https://github.com/rhoinc/web-codebook/issues
- npm.io page: https://npm.io/package/webcodebook

## Dependencies (2)

- [d3](https://npm.io/package/d3.md) ~3
- [webcharts](https://npm.io/package/webcharts.md) ^1.10.0

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads

## Recent versions

- 1.6.2 (latest) — 2019-10-22
- 1.6.1 — 2018-10-24
- 1.6.0 — 2018-10-24
- 1.4.2 — 2018-07-25
- 1.4.1 — 2018-07-11
- 1.4.0 — 2018-06-12
- 1.3.1 — 2017-12-05
- 1.3.0 — 2017-11-08
- 1.2.0 — 2017-08-23
- 1.1.0 — 2017-07-06
- 1.0.3 — 2017-05-31
- 1.0.2 — 2017-05-22
- 1.0.1 — 2017-05-18
- 1.0.0 — 2017-05-04

## README

# Web Codebook

![alt tag](https://user-images.githubusercontent.com/31038805/33682586-fb48c2cc-da95-11e7-87d9-79982b1aa8ed.gif)

## 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](https://rhoinc.github.io/viz-library/examples/0009-web-codebook-demo/example.html). When the page loads, the user sees a "codebook" providing a graphical data summary for each data column.
 
 
![alt tag](https://user-images.githubusercontent.com/31038805/33683185-0f6d9c44-da98-11e7-829d-24f41e77ffc2.gif)


## Background

The web-codebook is inspired Frank Harrell's excellent `summarize` method from the [Hmisc R package](https://cran.r-project.org/web/packages/Hmisc/Hmisc.pdf). `summarize` creates concise data summaries with minimal user configuration. Further,  [Agustin Calatroni](http://graphics.rhoworld.com/pubs/SCT2007_Calatroni.pdf) and  [Shane Rosanbalm](https://github.com/RhoInc/sas-codebook) 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](https://github.com/RhoInc/web-codebook/wiki/Data-Guidelines) and the tool will automatically create a user interface (filters, etc.) based on the data set loaded. Initialize the chart like so: 

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

See the [API](https://github.com/RhoInc/web-codebook/wiki/API) and [Configuration](https://github.com/RhoInc/web-codebook/wiki/Codebook-Configuration) pages for more details about custom configurations. 

## Links 

- [Interactive Example](https://rhoinc.github.io/viz-library/examples/0009-web-codebook-demo/example.html)
- [Configuration](https://github.com/RhoInc/web-codebook/wiki/Codebook-Configuration) 
- [API](https://github.com/RhoInc/web-codebook/wiki/API)
- [Technical Documentation](https://github.com/RhoInc/web-codebook/wiki/Technical-Documentation) 
- [Data Guidelines](https://github.com/RhoInc/web-codebook/wiki/Data-Guidelines)

---
_Source: https://npm.io/package/webcodebook · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._