sentiment-swedish
Version:
Swedish translated, AFINN-based sentiment analysis for Node.js
67 lines (50 loc) • 2.84 kB
Markdown
## sentiment-swedish
#### Swedish translated, AFINN-based sentiment analysis for Node.js
##### Psst! Looking for the [English version](https://github.com/thisandagain/sentiment) made by ['thisandagain'](https://github.com/thisandagain)?
##### Then go [here](https://github.com/thisandagain/sentiment) instead, since this is a Swedish version of the module.
[](https://travis-ci.org/thisandagain/sentiment)
[](https://coveralls.io/github/thisandagain/sentiment?branch=develop)
[](https://david-dm.org/thisandagain/sentiment)
[](https://david-dm.org/thisandagain/sentiment#info=devDependencies)
Sentiment is a Node.js module that uses the [AFINN-165](http://www2.imm.dtu.dk/pubdb/views/publication_details.php?id=6010) wordlist to perform [sentiment analysis](http://en.wikipedia.org/wiki/Sentiment_analysis) on arbitrary blocks of input text. Sentiment provides several things:
- Performance (see benchmarks below)
- The ability to append and overwrite word / value pairs from the AFINN wordlist
- A build process that makes updating sentiment to future versions of the AFINN word list trivial
### Installation
```bash
npm install sentiment-swedish
```
### Usage
```javascript
var sentiment = require('sentiment-swedish');
var r1 = sentiment('Katter är dumma.');
console.dir(r1); // Score: -2, Comparative: -0.666
var r2 = sentiment('Katter är totalt fantastiska!');
console.dir(r2); // Score: 4, Comparative: 1
```
### Adding / overwriting words
You can append and/or overwrite values from AFINN by simply injecting key/value pairs into a sentiment method call:
```javascript
var sentiment = require('sentiment-swedish');
var result = sentiment('Katter är totalt fantastiska!', {
'katter': 5,
'fantastiska': 2
});
console.dir(result); // Score: 7, Comparative: 1.75
```
---
### Benchmarks
The primary motivation for designing `sentiment` was performance. As such, it includes a benchmark script within the test directory that compares it against the [Sentimental](https://github.com/thinkroth/Sentimental) module which provides a nearly equivalent interface and approach. Based on these benchmarks, running on a MacBook Pro with Node 0.12.7, `sentiment` is **twice as fast** as alternative implementations:
```bash
sentiment (Latest) x 544,714 ops/sec ±0.83% (99 runs sampled)
Sentimental (1.0.1) x 269,417 ops/sec ±1.06% (96 runs sampled)
```
To run the benchmarks yourself, simply:
```bash
make benchmark
```
---
### Testing
```bash
npm test
```