Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 63 lines (42 sloc) 2.193 kB
96dba82 @thinkroth Added TravisCI Build Status
authored
1 [![Build Status](https://secure.travis-ci.org/thinkroth/Sentimental.png)](http://travis-ci.org/thinkroth/Sentimental)
71aaa71 @thinkroth Updated readme
authored
2 # SentiMental - Putting the Mental in Sentimental
94b23da @thinkroth Initial commit
authored
3
dceeaf5 @tmarshall Fixed npm reference and used markup for link
tmarshall authored
4 Sentiment analysis tool for node.js based on the [AFINN-111 wordlist](http://www2.imm.dtu.dk/pubdb/views/publication_details.php?id=6010).
94b23da @thinkroth Initial commit
authored
5
71aaa71 @thinkroth Updated readme
authored
6 ## Install
dceeaf5 @tmarshall Fixed npm reference and used markup for link
tmarshall authored
7 $ npm install Sentimental
94b23da @thinkroth Initial commit
authored
8
9 ## Features
10
11 * Positivity ranking
12 * Negativity ranking
13 * Analyze - combines Positivity and Negativity ranking into an aggregate sentiment score
14
15 ## Example
16 ```js
17 var analyze = require('sentimental').analyze,
18 positivity = require('sentimental').positivity,
19 negativity = require('sentimental').negativity;
20
21 analyze("Hey you worthless scumbag"); //Score: -6, Comparative:-1.5
22 positivity("This is so cool"); //Score: 1, Comparative:.25
23 negativity("Hey you worthless scumbag"); //Score: 6, Comparative:1.5
24 ```
25
26
27
28 ## Running Tests
29
30 To run the test suite first invoke the following command within the repo, installing the development dependencies:
31
32 $ npm install
33
34 then run the tests:
35
36 $ make test
37
38
39
40 ## License
41
42 (The MIT License)
43
98d5f5f @thinkroth Updated readme
authored
44 Copyright (c) 2012 Kevin M Roth <kevinroth82@gmail.com>
94b23da @thinkroth Initial commit
authored
45
46 Permission is hereby granted, free of charge, to any person obtaining
47 a copy of this software and associated documentation files (the
48 'Software'), to deal in the Software without restriction, including
49 without limitation the rights to use, copy, modify, merge, publish,
50 distribute, sublicense, and/or sell copies of the Software, and to
51 permit persons to whom the Software is furnished to do so, subject to
52 the following conditions:
53
54 The above copyright notice and this permission notice shall be
55 included in all copies or substantial portions of the Software.
56
57 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
58 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
59 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
60 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
61 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
62 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
63 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Something went wrong with that request. Please try again.