Skip to content

Latest commit

 

History

History
337 lines (209 loc) · 10.6 KB

README.md

File metadata and controls

337 lines (209 loc) · 10.6 KB
Raw
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

AFINN-111

NPM version Build Status Coverage Status

A list of English words rated for valence.

Installation

npm install @stdlib/datasets-afinn-111

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).
  • To use as a general utility for the command line, install the corresponding CLI package globally.

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

var afinn111 = require( '@stdlib/datasets-afinn-111' );

afinn111()

Returns a list of 2477 English words (and phrases) rated for valence. Negative words have a negative valence ([-5,0)). Positive words have a positive valence ((0,5]). Neutral words have a valence of 0.

var words = afinn111();
/* returns
    [
        ['abandon',-2],
        ['abandoned',-2],
        ['abandons',-2],
        ['abducted',-2],
        ['abduction',-2],
        ['abductions',-2],
        ['abhor',-3],
        ['abhorred',-3],
        ['abhorrent',-3],
        ...
    ]
*/

Notes

  • The list includes misspelled words. Their presence is intentional, as such misspellings frequently occur in social media content.
  • All words are lowercase.
  • Words may contain numbers; e.g., n00b.
  • Some "words" are phrases; e.g., cool stuff, not good.
  • Words may contain apostrophes; e.g., can't stand.
  • Words may contain diaeresis; e.g., naïve.
  • Words may contain dashes; e.g., self-deluded, self-confident.

Examples

var afinn111 = require( '@stdlib/datasets-afinn-111' );

var words;
var dict;
var len;
var i;

words = afinn111();

// Convert to a dictionary...
len = words.length;
dict = {};
for ( i = 0; i < len; i++ ) {
    dict[ words[i][0] ] = words[i][1];
}
console.dir( dict );

CLI

Installation

To use as a general utility, install the CLI package globally

npm install -g @stdlib/datasets-afinn-111-cli

Usage

Usage: afinn-111 [options]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.
         --format fmt          Output format: 'csv' or 'ndjson'.

Notes

  • The CLI supports two output formats: comma-separated values (CSV) and newline-delimited JSON (NDJSON). The default output format is CSV.

Examples

$ afinn-111
word,valence
abandon,-2
abandoned,-2
abandons,-2
...

References

  • Nielsen, Finn Årup. 2011. "A new ANEW: Evaluation of a word list for sentiment analysis in microblogs." In Proceedings of the ESWC2011 Workshop on 'Making Sense of Microposts': Big Things Come in Small Packages., 718:93–98. CEUR Workshop Proceedings. http://ceur-ws.org/Vol-718/paper_16.pdf.
  • Hansen, Lars Kai, Adam Arvidsson, Finn Årup Nielsen, Elanor Colleoni, and Michael Etter. 2011. "Good Friends, Bad News - Affect and Virality in Twitter." In Future Information Technology: 6th International Conference, FutureTech 2011, Loutraki, Greece, June 28-30, 2011, Proceedings, Part II, edited by James J. Park, Laurence T. Yang, and Changhoon Lee, 34–43. Berlin, Heidelberg: Springer Berlin Heidelberg. doi:10.1007/978-3-642-22309-9_5.

License

The data files (databases) are licensed under an Open Data Commons Attribution 1.0 License and their contents are licensed under a Creative Commons Attribution 4.0 International Public License. The original dataset is attributed to Finn Årup Nielsen and can be found here. The software is licensed under Apache License, Version 2.0.

See Also

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat

Copyright

Copyright © 2016-2024. The Stdlib Authors.