gak

_gak_ (JavaScript Graph Analysis Kit for Event-Based Network Data)


$3

#### Algorithms

- gak.EventRank provides an implementation of the EventRank algorithm put forth by O’Madadhain & Smyth, 2005.
- Further development goals include adding ECODE for event based clustering, as well as other static graph analysis algorithms.

$3

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

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

$3

See http://crosslead.github.io/gak for esdoc generated documentation.

$3

##### 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: , to: >, from: }
* sorted by the time property.
*
* NOTE: default parameters assume time is in milliseconds since the epoch
*/
const events = [ / Add events here... / ];

const R = new EventRank({ events });

// compute EventRank values
R.compute();

console.log(R.ranks); // => { ranks... }


/**
* To lazily compute a stream of events, call step()...
*
* Note, the model will need to be initially fed a set of
* correspondents to track
*/

const correspondents = [
// email address (or whatever is in the to/from properties of the events) 1...
// email address 2...
];

const R = new EventRank({ correspondents });

eventStream.on('event', event => {
R.step(event);
});

// if lazily computing, the ranks need to be finished by calling done();
R.done();

console.log(R.ranks); // => { ranks... }


/**
* If 2 (or more) events can occur at the exact same time,
* EventRank can process "bucketed" events...
*/

const correspondents = [
// email address 1...
// email address 2...
];

const R = new EventRank({ correspondents });

let bucket;
eventStream.on('event', event => {
if (bucket && bucket.time !== event.time) {
R.step(bucket);
bucket = { events: [ event ], time: event.time };
} else if (!bucket) {
bucket = { events: [ event ], time: event.time };
} else {
bucket.events.push(event);
}
});

// include last bucket...
R.step(bucket);

// if lazily computing, the ranks need to be finished by calling done();
R.done();

console.log(R.ranks); // => { ranks... }
``