The cl-sentiment Reference Manual

Table of Contents

The cl-sentiment Reference Manual

This is the cl-sentiment Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Mar 25 17:37:12 2020 GMT+0.

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.

2.1 cl-sentiment

Author

Rob Blackwell

Description

A sentiment analysis library for Common Lisp.

Version

0.0.1

Dependencies

• cl-ppcre
• rt

Source

cl-sentiment.asd (file)

Components

• package.lisp (file)
• sentiment.lisp (file)
• tests.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 cl-sentiment.asd

Location

cl-sentiment.asd

Systems

cl-sentiment (system)

3.1.2 cl-sentiment/package.lisp

Parent

cl-sentiment (system)

Location

package.lisp

Packages

cl-sentiment

3.1.3 cl-sentiment/sentiment.lisp

Dependency

package.lisp (file)

Parent

cl-sentiment (system)

Location

sentiment.lisp

Exported Definitions

• initialize (function)
• load-word-scores (function)
• sentiment (function)

Internal Definitions

• *word-scores* (special variable)
• words (function)

3.1.4 cl-sentiment/tests.lisp

Dependency

sentiment.lisp (file)

Parent

cl-sentiment (system)

Location

tests.lisp

4 Packages

Packages are listed by definition order.

4.1 cl-sentiment

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• initialize (function)
• load-word-scores (function)
• sentiment (function)

Internal Definitions

• *word-scores* (special variable)
• words (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: initialize &optional FILENAME

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

Package

cl-sentiment

Source

sentiment.lisp (file)

Function: load-word-scores FILENAME

Loads a word score table from a tab separated file.

Package

cl-sentiment

Source

sentiment.lisp (file)

Function: sentiment TEXT &optional TABLE

Returns the sentiment measure for the given text.

Package

cl-sentiment

Source

sentiment.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *word-scores*

Package

cl-sentiment

Source

sentiment.lisp (file)

5.2.2 Functions

Function: words TEXT

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

Package

cl-sentiment

Source

sentiment.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types