morningstar-equity-classification/README.md

Simple JSON map (indexed) for the equity classification system of Morningstar

Morningstar Equity Classification System Map (MECS)
==================================================

This library just aims to enable lookups in the reference table of Morningstar as published on their [website](http://corporate.morningstar.com/us/documents/methodologydocuments/methodologypapers/equityclassmethodology.pdf) in an easy way by build a Node module containing a JSON map and some methods.

## Installation

```shell
npm install morningstar-equity-classification
```

## Usage

```javascript
var MECS = require('morningstar-equity-classification');

MECS.all()
//=> [ { code: 1 }... ]

MECS.search('finance');
//=> [ { code: 10320052 }... ]

MECS.find('31169148');
//=> { code: 31169148, name: 'Solar' }

MECS.above('31169148');
//=> [ { code: 31169148 }, { code: 31169 }, { code: 311 }, { code: 3 }... ]

MECS.below('9261');
//=> [ { code: 92615 }, { code: 926150 }... ]
```

## Dataset Indexing

In order to enable keyword-based searches on the MECS dataset, we use a reverse index stored in ``/data/data-index.json``. The index is generated by tokenizing relevant properties on MECS classifications and storing them in an index object keyed by the tokenized text. The index relates keywords to scores that represent the likelihood that a specific keyword is related to a MECS classification.

In order to rebuild the index run the following command from the project directory:

```shell
$ ./bin/build-index.js
```

Most of the work comes from [@lovehandle/naics-2012](https://github.com/lovehandle/naics-2012)