<commit_before>## _gak_ (JavaScript Graph Analysis Kit for Event-Based Network Data)

[![npm version](https://badge.fury.io/js/gak.svg)](http://badge.fury.io/js/gak)
[![Bower version](https://badge.fury.io/bo/gak.svg)](http://badge.fury.io/bo/gak)
[![Build Status](https://travis-ci.org/CrossLead/gak.svg?branch=master)](https://travis-ci.org/CrossLead/gak)
[![Dependency Status](https://david-dm.org/crosslead/gak.svg)](https://david-dm.org/crosslead/gak)

### *Very Very Alpha, beware!*

### Overview

`gak.EventRank` provides an implementation of the EventRank algorithm put forth by (<NAME>, 2005), see http://www.datalab.uci.edu/papers/linkkdd05-02.pdf. Further development goals include adding ECODE for event based clustering, as well as other static graph analysis algorithms.


### Installation

##### npm
```shell
npm install --save gak
```

##### bower
```shell
bower install --save gak
```

### Documentation

See http://crosslead.github.io/gak for [esdoc](https://github.com/esdoc/esdoc) generated documentation.

### Usage

##### EventRank

To calculate EventRanks of `correspondents` involved in a series of `events` sorted by time...

```javascript

import { EventRank } from 'gak';

/**
  * Events should be an Array of objects of the form...
  *    { time: <Number>, to: <String|Array<String>>, from: <String> }<commit_msg>readme tweaks<commit_after>## _gak_ (JavaScript Graph Analysis Kit for Event-Based Network Data)

[![npm version](https://badge.fury.io/js/gak.svg)](http://badge.fury.io/js/gak)
[![Bower version](https://badge.fury.io/bo/gak.svg)](http://badge.fury.io/bo/gak)
[![Build Status](https://travis-ci.org/CrossLead/gak.svg?branch=master)](https://travis-ci.org/CrossLead/gak)
[![Dependency Status](https://david-dm.org/crosslead/gak.svg)](https://david-dm.org/crosslead/gak)

### Overview

#### Algorithms

- `gak.EventRank` provides an implementation of the EventRank algorithm put forth by [<NAME>, 2005](http://www.datalab.uci.edu/papers/linkkdd05-02.pdf).
- Further development goals include adding ECODE for event based clustering, as well as other static graph analysis algorithms.


### Installation

##### npm
```shell
npm install --save gak
```

##### bower
```shell
bower install --save gak
```

### Documentation

See http://crosslead.github.io/gak for [esdoc](https://github.com/esdoc/esdoc) generated documentation.

### Usage

##### EventRank

To calculate EventRanks of `correspondents` involved in a series of `events` sorted by time...

```javascript

import { EventRank } from 'gak';

/**
  * Events should be an Array of objects of the form...
  *    { time: <Number>, to: <String|Array<String>>, from: <String> }
{'fraction_non_alphanumeric': 0.17547806524184478, 'fraction_numerical': 0.005999250093738283, 'mean_word_length': 4.569937369519833, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 13, 'https://': 14, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '436537', 'n_tokens_mistral': 944, 'n_tokens_neox': 884, 'n_words': 222}