The cl-sentiment Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-sentiment Reference Manual

This is the cl-sentiment Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 04:02:05 2022 GMT+0.

Table of Contents


1 Introduction

cl-sentiment

cl-sentiment is a Common Lisp library that uses the AFINN-111 word list to perform sentiment analysis on arbitrary text.

Inspired by https://github.com/thisandagain/sentiment, it's particularly suited to looking at Twitter tweets.

The AFINN word list is by Finn Arup Nielsen available from http://www2.imm.dtu.dk/pubdb/views/publication_details.php?id=6010

You might also like to read his paper:

"A new ANEW: Evaluation of a word list for sentiment analysis in microblogs", Proceedings of the ESWC2011 Workshop on 'Making Sense of Microposts': Big things come in small packages 718 in CEUR Workshop Proceedings : 93-98. 2011 May. http://arxiv.org/abs/1103.2903

The AFINN files are copyright protected and distributed under the terms of the Open Database License (ODbL) v1.0, http://www.opendatacommons.org/licenses/odbl/1.0/

cl-sentiment is now available via Quicklisp.

Use initialize to initialize cl-sentiment with the default sentiment word scores.

Call sentiment with some arbitrary text and it returns two values - the sentiment score and the comparative sentiment score. Positive values convey positive sentiment; negative values convey negative sentiment.

Example

CL-USER> (ql:quickload "cl-sentiment")
...
CL-USER> (cl-sentiment:initialize)
#<HASH-TABLE :TEST EQUAL :COUNT 2477 {1003A54463}>
CL-USER> (cl-sentiment:sentiment "Cats are totally amazing!")
4
1
CL-USER> 

Rob Blackwell

December 2012


2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 cl-sentiment

A sentiment analysis library for Common Lisp.

Author

Rob Blackwell

Version

0.0.1

Dependencies
  • cl-ppcre (system).
  • rt (system).
Source

cl-sentiment.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.1 cl-sentiment/cl-sentiment.asd

Source

cl-sentiment.asd.

Parent Component

cl-sentiment (system).

ASDF Systems

cl-sentiment.


3.1.2 cl-sentiment/package.lisp

Source

cl-sentiment.asd.

Parent Component

cl-sentiment (system).

Packages

cl-sentiment.


3.1.3 cl-sentiment/sentiment.lisp

Dependency

package.lisp (file).

Source

cl-sentiment.asd.

Parent Component

cl-sentiment (system).

Public Interface
Internals

3.1.4 cl-sentiment/tests.lisp

Dependency

sentiment.lisp (file).

Source

cl-sentiment.asd.

Parent Component

cl-sentiment (system).


4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 cl-sentiment

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Public Interface


5.1.1 Ordinary functions

Function: initialize (&optional filename)

Initializes cl-sentiment with a default word-score table.

Package

cl-sentiment.

Source

sentiment.lisp.

Function: load-word-scores (filename)

Loads a word score table from a tab separated file.

Package

cl-sentiment.

Source

sentiment.lisp.

Function: sentiment (text &optional table)

Returns the sentiment measure for the given text.

Package

cl-sentiment.

Source

sentiment.lisp.


5.2 Internals


Next: , Previous: , Up: Internals   [Contents][Index]

5.2.1 Special variables

Special Variable: *word-scores*
Package

cl-sentiment.

Source

sentiment.lisp.


Previous: , Up: Internals   [Contents][Index]

5.2.2 Ordinary functions

Function: words (text)

Returns a list of words in the given text using simplistic tokenization.

Package

cl-sentiment.

Source

sentiment.lisp.


Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*word-scores*: Private special variables

S
Special Variable, *word-scores*: Private special variables

Jump to:   *  
S