<commit_before>[![NPM version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Coverage Status][coveralls-image]][coveralls-url]
[![Dependencies][dependencies-image]][dependencies-url]

# tweet-sentiment

> SVM Classifier to Detect Sentiment of Tweets. The package implements the procedure described in ["NRC-Canada: Building the State-of-the-Art in the paper
Sentiment Analysis of Tweets"](http://www.umiacs.umd.edu/~saif/WebDocs/sentimentMKZ.pdf) by <NAME>, <NAME>, and <NAME>

[npm-image]: https://badge.fury.io/js/tweet-sentiment.svg
[npm-url]: http://badge.fury.io/js/tweet-sentiment

[travis-image]: https://travis-ci.org/Planeshifter/tweet-sentiment.svg
[travis-url]: https://travis-ci.org/Planeshifter/tweet-sentiment

[coveralls-image]: https://img.shields.io/coveralls/Planeshifter/tweet-sentiment/master.svg
[coveralls-url]: https://coveralls.io/r/Planeshifter/tweet-sentiment?branch=master
<commit_msg>[UPDATE] README.md<commit_after>[![NPM version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Coverage Status][coveralls-image]][coveralls-url]
[![Dependencies][dependencies-image]][dependencies-url]

# tweet-sentiment

> SVM Classifier to Detect Sentiment of Tweets. The package implements the procedure described in ["NRC-Canada: Building the State-of-the-Art in the paper
Sentiment Analysis of Tweets"](http://www.umiacs.umd.edu/~saif/WebDocs/sentimentMKZ.pdf) by <NAME>, <NAME>, and <NAME>

## Installation

The tool should be installed globally such that it can be invoked from any directory in the terminal via the command tweet-sentiment.

```
npm install tweet-sentiment -g
```

## Getting Started

After installation, it is possible to obtain help about the possible options of the program by typing

```
tweet-sentiment --help
```

## Command Line Interface

### tweet-sentiment predict [options] \<file\>

First Header  | Second Header
------------- | -------------
-h, --help            | output usage information
-o, --output [value]  | Name of output file

[npm-image]: https://badge.fury.io/js/tweet-sentiment.svg
[npm-url]: http://badge.fury.io/js/tweet-sentiment

[travis-image]: https://travis-ci.org/Planeshifter/tweet-sentiment.svg
[travis-url]: https://travis-ci.org/Planeshifter/tweet-sentiment

[coveralls-image]: https://img.shields.io/coveralls/Planeshifter/tweet-sentiment/master.svg
[coveralls-url]: https://coveralls.io/r/Planeshifter/tweet-sentiment?branch=master

{'fraction_non_alphanumeric': 0.16292364230298081, 'fraction_numerical': 0.0, 'mean_word_length': 4.861244019138756, 'pattern_counts': {'":': 0, '<': 10, '<?xml version=': 0, '>': 12, 'https://': 10, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4680994', 'n_tokens_mistral': 871, 'n_tokens_neox': 831, 'n_words': 172}