retext-sentiment's Introduction

retext-sentiment

Detect the sentiment of text with Retext.

Installation

npm:

$ npm install retext-sentiment

Component:

$ component install wooorm/retext-sentiment

Bower:

$ bower install retext-sentiment

Usage

var Retext = require('retext');
var visit = require('retext-visit');
var sentiment = require('retext-sentiment');

var retext = new Retext()
    .use(visit)
    .use(sentiment);

retext.parse(
    'Haha hanks and happy birthday!!!!! ' +
    'I hate forgetting to bring a book somewhere I ' +
    'definitely should have brought a book to. ' +
    'Hate having to wait a whole week until the next game now.',
    function (err, tree) {
        console.log(tree.data.valence, tree.data.polarity);
        /**
         * 'neutral', 0
         */

        tree.visit(tree.SENTENCE_NODE, function (sentenceNode) {
            console.log(sentenceNode.data.valence, sentenceNode.data.polarity);
        });
        /**
         * 'positive', 6
         * 'negative', -3
         * 'negative', -3
         */

        tree.visit(tree.WORD_NODE, function (wordNode) {
            if (!wordNode.data.polarity) {
                return;
            }

            console.log(wordNode.toString(), wordNode.data.valence);
        });
        /**
         * 'Haha', 'positive'
         * 'happy', 'positive'
         * 'hate', 'negative'
         * 'Hate', 'negative'
         */
    }
);

Supported Words

retext-sentiment supports all words wooorm/afinn-111 supports.

API

None, retext-sentiment automatically detects the sentiment of each word (using wooorm/afinn-111), and stores the valence in word.data.valence, and polarity in word.data.polarity.

In addition, the plugin exposes the average of the detected sentiment on parents (sentences, paragraphs, and root nodes), through the same valence and polarity properties.

Valence? Either "neutral", "positive", or "negative". Polarity? A number between -5 and 5 (both including).