# ae-timelines

> Adverse event timelines for clinical trials

Latest version **2.1.6** (published 2019-08-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install ae-timelines
pnpm add ae-timelines
yarn add ae-timelines
bun add ae-timelines
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.6 |
| Published | 2019-08-19 |
| First published | 2016-06-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 102.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Rho, Inc. |
| Maintainers | jwildfire, pburnsdata, rhographics, samussiah |

## Links

- npm: https://www.npmjs.com/package/ae-timelines
- Repository: https://github.com/RhoInc/ae-timelines
- Homepage: https://github.com/RhoInc/ae-timelines#readme
- Issues: https://github.com/RhoInc/ae-timelines/issues
- npm.io page: https://npm.io/package/ae-timelines

## Dependencies (2)

- [d3](https://npm.io/package/d3.md) ^3.5.14
- [webcharts](https://npm.io/package/webcharts.md) ^1.9.0

## Recent versions

- 2.1.6 (latest) — 2019-08-19
- 2.1.5 — 2019-05-01
- 2.1.4 — 2019-03-28
- 2.1.3 — 2019-01-18
- 2.1.0 — 2018-04-27
- 2.0.4 — 2017-12-15
- 2.0.3 — 2017-10-16
- 2.0.1 — 2017-03-13
- 2.0.0 — 2017-02-21
- 1.2.1 — 2016-06-22
- 1.2.0 — 2016-06-22
- 1.1.0 — 2016-06-09

## README

# Adverse Event Timelines 
![alt tag](https://user-images.githubusercontent.com/31038805/31092946-129c8044-a77e-11e7-9f2f-4ba855684cdf.gif)

## Overview
AE-timelines is a JavaScript library built using Webcharts ([1](https://github.com/RhoInc/Webcharts), [2](https://github.com/RhoInc/webcharts-wrapper-boilerplate)) that creates an adverse event timeline for each participant in a clinical trial. Clicking on the y-axis tick labels also opens an adverse event-level participant view.

Users can filter and sort the timelines and drill down to each participant; the full functionality is described [here](https://github.com/RhoInc/ae-timelines/wiki/Technical-Documentation).
The library expects an [ADaM data structure](https://www.cdisc.org/system/files/members/standard/foundational/adam/ADaM_OCCDS_v1.0.pdf) by default but can be customized to use any dataset that is one record per adverse event.
Full details about chart configuration are [here](https://github.com/RhoInc/ae-timelines/wiki/Configuration).

## Typical Usage
Provided the input data matches the ADaM standard, the code to initialize the chart looks like this: 

```javascript
    d3.csv('ADAE.csv', function(data) {
        aeTimelines('body', {}).init(data);
    });

```

The chart can be configured to facilitate non-standard data formats and to alter the chart itself. Overwrite the defaults with a custom settings object like so:

```javascript
    let settings = {
        stdy_col: 'AESTDY',
        endy_col: 'AEENDY',
        color: {
           value_col: 'AEREL',
           label: 'Relationship'},
        filters: [
           {value_col: 'SEX', label: 'Sex'},
           {value_col: 'RACE', label: 'Race'},
           {value_col: 'ARM', label: 'Description of Planned Arm'}],
        details: [
           {value_col: 'INVID', label: 'Investigator Identifier'},
           {value_col: 'AGE', label: 'Age'},
           {value_col: 'AEDECOD', label: 'Dictionary-Derived Term'},
           {value_col: 'AEBODSYS', label: 'Body System or Organ Class'}],
        };

    d3.csv('AE.csv', function(data) {
        aeTimelines('body', settings).init(data);
    });

```

## Links
- [Interactive Example](https://rhoinc.github.io/ae-timelines/test-page/)
- [Configuration](https://github.com/RhoInc/ae-timelines/wiki/Configuration) 
- [API](https://github.com/RhoInc/ae-timelines/wiki/API)
- [Technical Documentation](https://github.com/RhoInc/ae-timelines/wiki/Technical-Documentation) 
- [Data Guidelines](https://github.com/RhoInc/ae-timelines/wiki/Data-Guidelines)

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