| Title: | Calculate Text Polarity Sentiment |
|---|---|
| Description: | Calculate text polarity sentiment at the sentence level and optionally aggregate by rows or grouping variable(s). |
| Authors: | Tyler Rinker [aut, cre] |
| Maintainer: | Tyler Rinker <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 2.9.1 |
| Built: | 2024-09-19 03:13:16 UTC |
| Source: | https://github.com/trinker/sentimentr |
as_key - Create your own hash keys from a data frame for use in key
arguments such as polarity_dt in the sentiment function.
update_key - Add/remove terms to a current key.
update_polarity_table - Wrapper for update_key specifically for
updating polarity tables.
update_valence_shifter_table - Wrapper for update_key
specifically for updating valence shifter tables.
is_key - Logical check if an object is a key.
as_key(x, comparison = lexicon::hash_valence_shifters, sentiment = TRUE, ...) update_key( key, drop = NULL, x = NULL, comparison = lexicon::hash_valence_shifters, sentiment = FALSE, ... ) update_polarity_table( key, drop = NULL, x = NULL, comparison = lexicon::hash_valence_shifters, sentiment = FALSE, ... ) update_valence_shifter_table( key, drop = NULL, x = NULL, comparison = lexicon::hash_sentiment_jockers_rinker, sentiment = FALSE, ... ) is_key(key, sentiment = TRUE)as_key(x, comparison = lexicon::hash_valence_shifters, sentiment = TRUE, ...) update_key( key, drop = NULL, x = NULL, comparison = lexicon::hash_valence_shifters, sentiment = FALSE, ... ) update_polarity_table( key, drop = NULL, x = NULL, comparison = lexicon::hash_valence_shifters, sentiment = FALSE, ... ) update_valence_shifter_table( key, drop = NULL, x = NULL, comparison = lexicon::hash_sentiment_jockers_rinker, sentiment = FALSE, ... ) is_key(key, sentiment = TRUE)
x |
A |
comparison |
A |
sentiment |
logical. If |
key |
A sentimentr hash key. |
drop |
A vector of terms to drop. |
... |
ignored. |
For updating keys via update_key note that a
polarity_dt and valence_shifters_dt are the primary dictionary
keys used in the sentimentr package. The polarity_dt takes a
2 column data.frame (named x and y) with the first column being
character and containing the words and the second column being numeric values
that are positive or negative. valence_shifters_dt takes a 2 column
data.frame (named x and y) with the first column being character and
containing the words and the second column being integer corresponding to:
(1) negators, (2) amplifiers, (3) de-amplifiers, and (4) dversative
conjunctions (i.e., 'but', 'however', and 'although'). Also, note that if
you are updating a valence_shifters_dt you need an appropriate
comparison; most likely, comparison = sentimentr::polarity_dt.
Returns a data.table object that can be used as a hash key.
key <- data.frame( words = sample(letters), polarity = rnorm(26), stringsAsFactors = FALSE ) (mykey <- as_key(key)) ## Looking up values mykey[c("a", "k")][[2]] ## Drop terms from key update_key(mykey, drop = c("f", "h")) ## Add terms to key update_key(mykey, x = data.frame(x = c("dog", "cat"), y = c(1, -1))) ## Add terms & drop to/from a key update_key(mykey, drop = c("f", "h"), x = data.frame(x = c("dog", "cat"), y = c(1, -1))) ## Explicity key type (wrapper for `update_key` for sentiment table. ## See `update_valence_shifter_table` a corresponding valence shifter updater. library(lexicon) updated_hash_sentiment <- sentimentr:::update_polarity_table(lexicon::hash_sentiment_huliu, x = data.frame( words = c('frickin', 'hairy'), polarity = c(-1, -1), stringsAsFactors = FALSE ) ) ## Checking if you have a key is_key(mykey) is_key(key) is_key(mtcars) is_key(update_key(mykey, drop = c("f", "h"))) ## Using syuzhet's sentiment lexicons ## Not run: library(syuzhet) (bing_key <- as_key(syuzhet:::bing)) as_key(syuzhet:::afinn) as_key(syuzhet:::syuzhet_dict) sam <- gsub("Sam-I-am", "Sam I am", sam_i_am) sentiment(sam, , polarity_dt = bing_key) ## The nrc dictionary in syuzhet requires a bit of data wrangling before it ## is in the correct shape to convert to a key. library(syuzhet) library(tidyverse) nrc_key <- syuzhet:::nrc %>% dplyr::filter( sentiment %in% c('positive', 'negative'), lang == 'english' ) %>% dplyr::select(-lang) %>% mutate(value = ifelse(sentiment == 'negative', value * -1, value)) %>% dplyr::group_by(word) %>% dplyr::summarize(y = mean(value)) %>% sentimentr::as_key() sentiment(sam, polarity_dt = nrc_key) ## The lexicon package contains a preformatted nrc sentiment hash table that ## can be used instead. sentiment(sam, polarity_dt = lexicon::hash_sentiment_nrc) ## End(Not run) ## Using 2 vectors of words ## Not run: install.packages("tm.lexicon.GeneralInquirer", repos="http://datacube.wu.ac.at", type="source") require("tm.lexicon.GeneralInquirer") positive <- terms_in_General_Inquirer_categories("Positiv") negative <- terms_in_General_Inquirer_categories("Negativ") geninq <- data.frame( x = c(positive, negative), y = c(rep(1, length(positive)), rep(-1, length(negative))), stringsAsFactors = FALSE ) %>% as_key() geninq_pol <- with(presidential_debates_2012, sentiment_by(dialogue, person, polarity_dt = geninq )) geninq_pol %>% plot() ## End(Not run)key <- data.frame( words = sample(letters), polarity = rnorm(26), stringsAsFactors = FALSE ) (mykey <- as_key(key)) ## Looking up values mykey[c("a", "k")][[2]] ## Drop terms from key update_key(mykey, drop = c("f", "h")) ## Add terms to key update_key(mykey, x = data.frame(x = c("dog", "cat"), y = c(1, -1))) ## Add terms & drop to/from a key update_key(mykey, drop = c("f", "h"), x = data.frame(x = c("dog", "cat"), y = c(1, -1))) ## Explicity key type (wrapper for `update_key` for sentiment table. ## See `update_valence_shifter_table` a corresponding valence shifter updater. library(lexicon) updated_hash_sentiment <- sentimentr:::update_polarity_table(lexicon::hash_sentiment_huliu, x = data.frame( words = c('frickin', 'hairy'), polarity = c(-1, -1), stringsAsFactors = FALSE ) ) ## Checking if you have a key is_key(mykey) is_key(key) is_key(mtcars) is_key(update_key(mykey, drop = c("f", "h"))) ## Using syuzhet's sentiment lexicons ## Not run: library(syuzhet) (bing_key <- as_key(syuzhet:::bing)) as_key(syuzhet:::afinn) as_key(syuzhet:::syuzhet_dict) sam <- gsub("Sam-I-am", "Sam I am", sam_i_am) sentiment(sam, , polarity_dt = bing_key) ## The nrc dictionary in syuzhet requires a bit of data wrangling before it ## is in the correct shape to convert to a key. library(syuzhet) library(tidyverse) nrc_key <- syuzhet:::nrc %>% dplyr::filter( sentiment %in% c('positive', 'negative'), lang == 'english' ) %>% dplyr::select(-lang) %>% mutate(value = ifelse(sentiment == 'negative', value * -1, value)) %>% dplyr::group_by(word) %>% dplyr::summarize(y = mean(value)) %>% sentimentr::as_key() sentiment(sam, polarity_dt = nrc_key) ## The lexicon package contains a preformatted nrc sentiment hash table that ## can be used instead. sentiment(sam, polarity_dt = lexicon::hash_sentiment_nrc) ## End(Not run) ## Using 2 vectors of words ## Not run: install.packages("tm.lexicon.GeneralInquirer", repos="http://datacube.wu.ac.at", type="source") require("tm.lexicon.GeneralInquirer") positive <- terms_in_General_Inquirer_categories("Positiv") negative <- terms_in_General_Inquirer_categories("Negativ") geninq <- data.frame( x = c(positive, negative), y = c(rep(1, length(positive)), rep(-1, length(negative))), stringsAsFactors = FALSE ) %>% as_key() geninq_pol <- with(presidential_debates_2012, sentiment_by(dialogue, person, polarity_dt = geninq )) geninq_pol %>% plot() ## End(Not run)
See available sentimentr data a data.frame. Note that
sentimentr_data is the main function to be used but
available_data is exposed to allow other packages to use the
functionality in a generic way.
available_data(regex = NULL, package = "sentimentr", ...) sentimentr_data(regex = NULL, package = "sentimentr", ...)available_data(regex = NULL, package = "sentimentr", ...) sentimentr_data(regex = NULL, package = "sentimentr", ...)
regex |
A regex to search for within the data columns. |
package |
The name of the package to extract data from. |
... |
Other arguments passed to |
Returns a data.frame
sentimentr_data() available_data() ## generic version for export available_data(package = 'datasets') sentimentr_data('^hu') sentimentr_data('^(hu|kot)') combine_data(sentimentr_data('^(hu|kot)')[[1]]) ## Not run: if (!require("pacman")) install.packages("pacman") pacman::p_load(sentimentr, tidyverse, magrittr) sentiment_data <- sentimentr_data('^hu') %>% pull(Data) %>% combine_data() %>% mutate(id = seq_len(n())) %>% as_tibble() sentiment_test <- sentiment_data %>% select(-sentiment) %>% get_sentences() %$% sentiment(., by = c('id')) testing <- sentiment_data %>% left_join(sentiment_test, by = 'id') %>% as_tibble() %>% mutate( actual = sign(sentiment), predicted = sign(ave_sentiment) ) testing %$% ftable(predicted, actual) ## End(Not run)sentimentr_data() available_data() ## generic version for export available_data(package = 'datasets') sentimentr_data('^hu') sentimentr_data('^(hu|kot)') combine_data(sentimentr_data('^(hu|kot)')[[1]]) ## Not run: if (!require("pacman")) install.packages("pacman") pacman::p_load(sentimentr, tidyverse, magrittr) sentiment_data <- sentimentr_data('^hu') %>% pull(Data) %>% combine_data() %>% mutate(id = seq_len(n())) %>% as_tibble() sentiment_test <- sentiment_data %>% select(-sentiment) %>% get_sentences() %$% sentiment(., by = c('id')) testing <- sentiment_data %>% left_join(sentiment_test, by = 'id') %>% as_tibble() %>% mutate( actual = sign(sentiment), predicted = sign(ave_sentiment) ) testing %$% ftable(predicted, actual) ## End(Not run)
average_downweighted_zero- Downweight the zeros in a vector for
averaging. This is useful in the context of language where we don't want the
neutral sentences to have such a strong influence on the general sentiment of
the discourse with multiple sentences. Essentially, this means neutral
sentences are seen as having less emotional impact than a polarized sentence.
average_weighted_mixed_sentiment- Upweight the negative values in a
vector while also downweighting the zeros in a vector. Useful for small text
chunks with several sentences in which some one states a negative sentence
but then uses the social convention of several positive sentences in an
attempt to negate the impact of the negative. The affective state isn't
a neutral but a slightly lessened negative state.
average_mean- Standard mean averaging with na.rm set to TRUE.
average_downweighted_zero(x, na.rm = TRUE, ...) average_weighted_mixed_sentiment( x, mixed.less.than.zero.weight = 4, na.rm = TRUE, ... ) average_mean(x, na.rm = TRUE, ...)average_downweighted_zero(x, na.rm = TRUE, ...) average_weighted_mixed_sentiment( x, mixed.less.than.zero.weight = 4, na.rm = TRUE, ... ) average_mean(x, na.rm = TRUE, ...)
x |
A numeric vector. |
na.rm |
logical. Should |
mixed.less.than.zero.weight |
The weighting factor to multiply the negative elements of the vector by (this increases the intensity of the negatives in the numerator of the mean formula). |
... |
ignored. |
Returns a scalar summary of the re-weighted average
x <- c(1, 2, 0, 0, 0, -1) mean(x) average_downweighted_zero(x) average_downweighted_zero(c(NA, x)) mean(c(0, 0, 0, x)) average_downweighted_zero(c(0, 0, 0, x))x <- c(1, 2, 0, 0, 0, -1) mean(x) average_downweighted_zero(x) average_downweighted_zero(c(NA, x)) mean(c(0, 0, 0, x)) average_downweighted_zero(c(0, 0, 0, x))
Combine trusted sentiment data sets from sentimentr.
combine_data( data = c("course_evaluations", "hotel_reviews", "kaggle_movie_reviews", "kotzias_reviews_amazon_cells", "kotzias_reviews_imdb", "kotzias_reviews_yelp", "nyt_articles"), ... )combine_data( data = c("course_evaluations", "hotel_reviews", "kaggle_movie_reviews", "kotzias_reviews_amazon_cells", "kotzias_reviews_imdb", "kotzias_reviews_yelp", "nyt_articles"), ... )
data |
A character vector of sentimentr data sets. |
... |
ignored. |
Returns an rbinded data.table of sentiment data with the source added as column.
combine_data() combine_data(c("kotzias_reviews_amazon_cells", "kotzias_reviews_imdb", "kotzias_reviews_yelp"))combine_data() combine_data(c("kotzias_reviews_amazon_cells", "kotzias_reviews_imdb", "kotzias_reviews_yelp"))
A dataset containing a subset of comments and rating from Welch & Mihalcea's (2017) data set filtered to include comments with a one or more unambiguous sentiment rating.
data(course_evaluations)data(course_evaluations)
A data frame with 566 rows and 2 variables
sentiment. A numeric sentiment score
text. The text from the evaluation
Welch, C. and Mihalcea, R. (2017). Targeted sentiment to
understand student comments. In Proceedings of the International Conference
on Computational Linguistics (COLING 2016).
Original URL: http://web.eecs.umich.edu/~mihalcea/downloads.html#GroundedEmotions
A dataset containing Twitter tweets about Tom Brady's deflated ball scandal, taken from Crowdflower.
data(crowdflower_deflategate)data(crowdflower_deflategate)
A data frame with 11,786 rows and 2 variables
sentiment. A human scoring of the text.
text. The sentences from the tweet.
Original URL: https://www.crowdflower.com/data-for-everyone
A dataset containing Twitter tweets about various products, taken from Crowdflower.
data(crowdflower_products)data(crowdflower_products)
A data frame with 3,548 rows and 2 variables
sentiment. A human scoring of the text.
text. The sentences from the tweet.
Cavender-Bares, K., (2013). Judge emotion about brands & products.
Original URL: https://www.crowdflower.com/data-for-everyone
A dataset containing Twitter tweets about self driving cars, taken from Crowdflower.
data(crowdflower_self_driving_cars)data(crowdflower_self_driving_cars)
A data frame with 6,943 rows and 2 variables
sentiment. A human scoring of the text.
text. The sentences from the tweet.
Original URL: https://www.crowdflower.com/data-for-everyone
A dataset containing Twitter tweets about the weather, taken from Crowdflower.
data(crowdflower_weather)data(crowdflower_weather)
A data frame with 763 rows and 2 variables
sentiment. A human scoring of the text.
text. The sentences from the tweet.
Original URL: https://www.crowdflower.com/data-for-everyone
Detect the rate of emotion at the sentence level. This method uses a simple
dictionary lookup to find emotion words and then compute the rate per sentence.
The emotion score ranges between 0 (no emotion used) and 1 (all
words used were emotional). Note that a single emotion phrase would count as
just one in the emotion_count column but would count as two words in
the word_count column.
emotion( text.var, emotion_dt = lexicon::hash_nrc_emotions, valence_shifters_dt = lexicon::hash_valence_shifters, drop.unused.emotions = FALSE, un.as.negation = TRUE, un.as.negation.warn = isTRUE(all.equal(valence_shifters_dt, lexicon::hash_nrc_emotions)), n.before = 5, n.after = 2, retention_regex = "[^[:alpha:];:,']", ... )emotion( text.var, emotion_dt = lexicon::hash_nrc_emotions, valence_shifters_dt = lexicon::hash_valence_shifters, drop.unused.emotions = FALSE, un.as.negation = TRUE, un.as.negation.warn = isTRUE(all.equal(valence_shifters_dt, lexicon::hash_nrc_emotions)), n.before = 5, n.after = 2, retention_regex = "[^[:alpha:];:,']", ... )
text.var |
The text variable. Can be a |
emotion_dt |
A data.table with a |
valence_shifters_dt |
A data.table of valence shifters that can alter a polarized word's meaning and an integer key for negators (1), amplifiers [intensifiers] (2), de-amplifiers [downtoners] (3) and adversative conjunctions (4) with x and y as column names. For this purpose only negators is required/used. |
drop.unused.emotions |
logical. If |
un.as.negation |
logical. If |
un.as.negation.warn |
logical. If |
n.before |
The number of words to consider as negated before
the emotion word. To consider the entire beginning portion of a sentence
use |
n.after |
The number of words to consider as negated after
the emotion word. To consider the entire ending portion of a sentence
use |
retention_regex |
A regex of what characters to keep. All other
characters will be removed. Note that when this is used all text is lower
case format. Only adjust this parameter if you really understand how it is
used. Note that swapping the |
... |
ignored. |
Returns a data.table of:
element_id - The id number of the original vector passed to emotion
sentence_id - The id number of the sentences within each element_id
word_count - Word count
emotion_type - Type designation from the emotion column of the emotion_dt table
emotion_count - Count of the number of emotion words of that emotion_type
emotion - A score of the percentage of emotion words of that emotion_type
Plutchik, R. (1962). The emotions: Facts and theories, and a new
model. Random House studies in psychology. Random House.
Plutchik, R. (2001). The nature of emotions: Human emotions have deep
evolutionary roots, a fact that may explain their complexity and provide tools
for clinical practice. American Scientist , 89 (4), 344-350.
Other emotion functions:
emotion_by()
mytext <- c( "I am not afraid of you", NA, "", "I love it [not really]", "I'm not angry with you", "I hate it when you lie to me. It's so humiliating", "I'm not happpy anymore. It's time to end it", "She's a darn good friend to me", "I went to the terrible store", "There is hate and love in each of us", "I'm no longer angry! I'm really experiencing peace but not true joy.", paste("Out of the night that covers me, Black as the Pit from pole to", "pole, I thank whatever gods may be For my unconquerable soul." ), paste("In the fell clutch of circumstance I have not winced nor cried", "aloud. Under the bludgeonings of chance My head is bloody, but unbowed." ), paste("Beyond this place of wrath and tears Looms but the Horror of the", "shade, And yet the menace of the years Finds, and shall find, me unafraid." ), paste("It matters not how strait the gate, How charged with punishments", "the scroll, I am the master of my fate: I am the captain of my soul." ) ) ## works on a character vector but not the preferred method avoiding the ## repeated cost of doing sentence boundary disambiguation every time ## `emotion` is run emotion(mytext) ## preferred method avoiding paying the cost split_text <- get_sentences(mytext) (emo <- emotion(split_text)) emotion(split_text, drop.unused.emotions = TRUE) ## Not run: plot(emo) plot(emo, drop.unused.emotions = FALSE) plot(emo, facet = FALSE) plot(emo, facet = 'negated') library(data.table) fear <- emo[ emotion_type == 'fear', ][, text := unlist(split_text)][] fear[emotion > 0,] brady <- get_sentences(crowdflower_deflategate) brady_emotion <- emotion(brady) brady_emotion ## End(Not run)mytext <- c( "I am not afraid of you", NA, "", "I love it [not really]", "I'm not angry with you", "I hate it when you lie to me. It's so humiliating", "I'm not happpy anymore. It's time to end it", "She's a darn good friend to me", "I went to the terrible store", "There is hate and love in each of us", "I'm no longer angry! I'm really experiencing peace but not true joy.", paste("Out of the night that covers me, Black as the Pit from pole to", "pole, I thank whatever gods may be For my unconquerable soul." ), paste("In the fell clutch of circumstance I have not winced nor cried", "aloud. Under the bludgeonings of chance My head is bloody, but unbowed." ), paste("Beyond this place of wrath and tears Looms but the Horror of the", "shade, And yet the menace of the years Finds, and shall find, me unafraid." ), paste("It matters not how strait the gate, How charged with punishments", "the scroll, I am the master of my fate: I am the captain of my soul." ) ) ## works on a character vector but not the preferred method avoiding the ## repeated cost of doing sentence boundary disambiguation every time ## `emotion` is run emotion(mytext) ## preferred method avoiding paying the cost split_text <- get_sentences(mytext) (emo <- emotion(split_text)) emotion(split_text, drop.unused.emotions = TRUE) ## Not run: plot(emo) plot(emo, drop.unused.emotions = FALSE) plot(emo, facet = FALSE) plot(emo, facet = 'negated') library(data.table) fear <- emo[ emotion_type == 'fear', ][, text := unlist(split_text)][] fear[emotion > 0,] brady <- get_sentences(crowdflower_deflategate) brady_emotion <- emotion(brady) brady_emotion ## End(Not run)
Approximate the emotion of text by grouping variable(s). For a
full description of the emotion detection algorithm see
emotion. See emotion
for more details about the algorithm, the emotion/valence shifter keys
that can be passed into the function, and other arguments that can be passed.
emotion_by(text.var, by = NULL, group.names, ...)emotion_by(text.var, by = NULL, group.names, ...)
text.var |
The text variable. Also takes a |
by |
The grouping variable(s). Default |
group.names |
A vector of names that corresponds to group. Generally for internal use. |
... |
Other arguments passed to |
Returns a data.table with grouping variables plus:
element_id - The id number of the original vector passed to emotion
sentence_id - The id number of the sentences within each element_id
word_count - Word count summed by grouping variable
emotion_type - Type designation from the emotion column of the emotion_dt table
emotion_count - The number of profanities used by grouping variable
sd - Standard deviation (sd) of the sentence level emotion rate by grouping variable
ave_emotion - Emotion rate
See the sentiment_by for details about sentimentr chaining.
Other emotion functions:
emotion()
## Not run: mytext <- c( "I am not afraid of you", NA, "", "I love it [not really]", "I'm not angry with you", "I hate it when you lie to me. It's so humiliating", "I'm not happpy anymore. It's time to end it", "She's a darn good friend to me", "I went to the terrible store", "There is hate and love in each of us", "I'm no longer angry! I'm really experiencing peace but not true joy.", paste("Out of the night that covers me, Black as the Pit from pole to", "pole, I thank whatever gods may be For my unconquerable soul.", "In the fell clutch of circumstance I have not winced nor cried", "aloud. Under the bludgeonings of chance My head is bloody, but unbowed.", "Beyond this place of wrath and tears Looms but the Horror of the", "shade, And yet the menace of the years Finds, and shall find, me unafraid.", "It matters not how strait the gate, How charged with punishments", "the scroll, I am the master of my fate: I am the captain of my soul." ) ) ## works on a character vector but not the preferred method avoiding the ## repeated cost of doing sentence boundary disambiguation every time ## `emotion` is run emotion(mytext) emotion_by(mytext) ## preferred method avoiding paying the cost mytext <- get_sentences(mytext) emotion_by(mytext) get_sentences(emotion_by(mytext)) (myemotion <- emotion_by(mytext)) stats::setNames(get_sentences(emotion_by(mytext)), round(myemotion[["ave_emotion"]], 3)) pres <- get_sentences(presidential_debates_2012) pres_emo_sent <- emotion_by(pres) ## method 1 pres_emo_per_time <- presidential_debates_2012 %>% get_sentences() %>% emotion_by(by = c('person', 'time')) pres_emo_per_time ## method 2 library(magrittr) presidential_debates_2012 %>% get_sentences() %$% emotion_by(., by = c('person', 'time')) ## method 3 presidential_debates_2012 %>% get_sentences() %$% emotion_by(dialogue, by = list(person, time)) ## method 4 presidential_debates_2012 %>% get_sentences() %>% with(emotion_by(dialogue, by = list(person, time))) plot(pres_emo_sent) plot(pres_emo_per_time) ## End(Not run)## Not run: mytext <- c( "I am not afraid of you", NA, "", "I love it [not really]", "I'm not angry with you", "I hate it when you lie to me. It's so humiliating", "I'm not happpy anymore. It's time to end it", "She's a darn good friend to me", "I went to the terrible store", "There is hate and love in each of us", "I'm no longer angry! I'm really experiencing peace but not true joy.", paste("Out of the night that covers me, Black as the Pit from pole to", "pole, I thank whatever gods may be For my unconquerable soul.", "In the fell clutch of circumstance I have not winced nor cried", "aloud. Under the bludgeonings of chance My head is bloody, but unbowed.", "Beyond this place of wrath and tears Looms but the Horror of the", "shade, And yet the menace of the years Finds, and shall find, me unafraid.", "It matters not how strait the gate, How charged with punishments", "the scroll, I am the master of my fate: I am the captain of my soul." ) ) ## works on a character vector but not the preferred method avoiding the ## repeated cost of doing sentence boundary disambiguation every time ## `emotion` is run emotion(mytext) emotion_by(mytext) ## preferred method avoiding paying the cost mytext <- get_sentences(mytext) emotion_by(mytext) get_sentences(emotion_by(mytext)) (myemotion <- emotion_by(mytext)) stats::setNames(get_sentences(emotion_by(mytext)), round(myemotion[["ave_emotion"]], 3)) pres <- get_sentences(presidential_debates_2012) pres_emo_sent <- emotion_by(pres) ## method 1 pres_emo_per_time <- presidential_debates_2012 %>% get_sentences() %>% emotion_by(by = c('person', 'time')) pres_emo_per_time ## method 2 library(magrittr) presidential_debates_2012 %>% get_sentences() %$% emotion_by(., by = c('person', 'time')) ## method 3 presidential_debates_2012 %>% get_sentences() %$% emotion_by(dialogue, by = list(person, time)) ## method 4 presidential_debates_2012 %>% get_sentences() %>% with(emotion_by(dialogue, by = list(person, time))) plot(pres_emo_sent) plot(pres_emo_per_time) ## End(Not run)
Extract the emotion words from a text.
extract_emotion_terms( text.var, emotion_dt = lexicon::hash_nrc_emotions, un.as.negation = TRUE, retention_regex = "[^[:alpha:];:,']", ... )extract_emotion_terms( text.var, emotion_dt = lexicon::hash_nrc_emotions, un.as.negation = TRUE, retention_regex = "[^[:alpha:];:,']", ... )
text.var |
The text variable. Can be a |
emotion_dt |
A data.table with a |
un.as.negation |
logical. If |
retention_regex |
A regex of what characters to keep. All other
characters will be removed. Note that when this is used all text is lower
case format. Only adjust this parameter if you really understand how it is
used. Note that swapping the |
... |
Ignored. |
Returns a data.table with a columns of emotion terms.
## Not run: mytext <- c( "I am not afraid of you", NA, "", "I love it [not really]", "I'm not angry with you", "I hate it when you lie to me. It's so humiliating", "I'm not happpy anymore. It's time to end it", "She's a darn good friend to me", "I went to the terrible store", "There is hate and love in each of us", "I'm no longer angry! I'm really experiencing peace but not true joy.", paste("Out of the night that covers me, Black as the Pit from pole to", "pole, I thank whatever gods may be For my unconquerable soul.", "In the fell clutch of circumstance I have not winced nor cried", "aloud. Under the bludgeonings of chance My head is bloody, but unbowed.", "Beyond this place of wrath and tears Looms but the Horror of the", "shade, And yet the menace of the years Finds, and shall find, me unafraid.", "It matters not how strait the gate, How charged with punishments", "the scroll, I am the master of my fate: I am the captain of my soul." ) ) mytext2 <- get_sentences(mytext) emotion(mytext2) emo_words <- extract_emotion_terms(mytext2) emo_words emo_words$sentence emo_words[, c('anger', 'anticipation', 'disgust', 'fear', 'joy', 'sadness', 'surprise', 'trust')] attributes(emo_words)$counts attributes(emo_words)$elements ## directly ona character string (not recommended: use `get_sentences` first) extract_emotion_terms(mytext) brady <- get_sentences(crowdflower_deflategate) brady_emo <- extract_emotion_terms(brady) brady_emo attributes(brady_emo)$counts attributes(brady_emo)$elements ## End(Not run)## Not run: mytext <- c( "I am not afraid of you", NA, "", "I love it [not really]", "I'm not angry with you", "I hate it when you lie to me. It's so humiliating", "I'm not happpy anymore. It's time to end it", "She's a darn good friend to me", "I went to the terrible store", "There is hate and love in each of us", "I'm no longer angry! I'm really experiencing peace but not true joy.", paste("Out of the night that covers me, Black as the Pit from pole to", "pole, I thank whatever gods may be For my unconquerable soul.", "In the fell clutch of circumstance I have not winced nor cried", "aloud. Under the bludgeonings of chance My head is bloody, but unbowed.", "Beyond this place of wrath and tears Looms but the Horror of the", "shade, And yet the menace of the years Finds, and shall find, me unafraid.", "It matters not how strait the gate, How charged with punishments", "the scroll, I am the master of my fate: I am the captain of my soul." ) ) mytext2 <- get_sentences(mytext) emotion(mytext2) emo_words <- extract_emotion_terms(mytext2) emo_words emo_words$sentence emo_words[, c('anger', 'anticipation', 'disgust', 'fear', 'joy', 'sadness', 'surprise', 'trust')] attributes(emo_words)$counts attributes(emo_words)$elements ## directly ona character string (not recommended: use `get_sentences` first) extract_emotion_terms(mytext) brady <- get_sentences(crowdflower_deflategate) brady_emo <- extract_emotion_terms(brady) brady_emo attributes(brady_emo)$counts attributes(brady_emo)$elements ## End(Not run)
Extract the profanity words from a text.
extract_profanity_terms( text.var, profanity_list = unique(tolower(lexicon::profanity_alvarez)), ... )extract_profanity_terms( text.var, profanity_list = unique(tolower(lexicon::profanity_alvarez)), ... )
text.var |
The text variable. Can be a |
profanity_list |
A atomic character vector of profane words. The lexicon package has lists that can be used, including:
|
... |
Ignored. |
Returns a data.table with a columns of profane terms.
## Not run: bw <- sample(lexicon::profanity_alvarez, 4) mytext <- c( sprintf('do you %s like this %s? It is %s. But I hate really bad dogs', bw[1], bw[2], bw[3]), 'I am the best friend.', NA, sprintf('I %s hate this %s', bw[3], bw[4]), "Do you really like it? I'm not happy" ) x <- get_sentences(mytext) profanity(x) prof_words <- extract_profanity_terms(x) prof_words prof_words$sentence prof_words$neutral prof_words$profanity data.table::as.data.table(prof_words) attributes(extract_profanity_terms(x))$counts attributes(extract_profanity_terms(x))$elements brady <- get_sentences(crowdflower_deflategate) brady_swears <- extract_profanity_terms(brady) attributes(extract_profanity_terms(brady))$counts attributes(extract_profanity_terms(brady))$elements ## End(Not run)## Not run: bw <- sample(lexicon::profanity_alvarez, 4) mytext <- c( sprintf('do you %s like this %s? It is %s. But I hate really bad dogs', bw[1], bw[2], bw[3]), 'I am the best friend.', NA, sprintf('I %s hate this %s', bw[3], bw[4]), "Do you really like it? I'm not happy" ) x <- get_sentences(mytext) profanity(x) prof_words <- extract_profanity_terms(x) prof_words prof_words$sentence prof_words$neutral prof_words$profanity data.table::as.data.table(prof_words) attributes(extract_profanity_terms(x))$counts attributes(extract_profanity_terms(x))$elements brady <- get_sentences(crowdflower_deflategate) brady_swears <- extract_profanity_terms(brady) attributes(extract_profanity_terms(brady))$counts attributes(extract_profanity_terms(brady))$elements ## End(Not run)
Extract the sentiment words from a text.
extract_sentiment_terms( text.var, polarity_dt = lexicon::hash_sentiment_jockers_rinker, hyphen = "", retention_regex = "\\d:\\d|\\d\\s|[^[:alpha:]',;: ]", ... )extract_sentiment_terms( text.var, polarity_dt = lexicon::hash_sentiment_jockers_rinker, hyphen = "", retention_regex = "\\d:\\d|\\d\\s|[^[:alpha:]',;: ]", ... )
text.var |
The text variable. |
polarity_dt |
A data.table of positive/negative words and weights with x and y as column names. |
hyphen |
The character string to replace hyphens with. Default replaces
with nothing so 'sugar-free' becomes 'sugarfree'. Setting |
retention_regex |
A regex of what characters to keep. All other
characters will be removed. Note that when this is used all text is lower
case format. Only adjust this parameter if you really understand how it is
used. Note that swapping the |
... |
Ignored. |
Returns a data.table with columns of positive and
negative terms. In addition, the attributes $counts and $elements
return an aggregated count of the usage of the words and a detailed sentiment
score of each word use. See the examples for more.
library(data.table) set.seed(10) x <- get_sentences(sample(hu_liu_cannon_reviews[[2]], 1000, TRUE)) sentiment(x) pol_words <- extract_sentiment_terms(x) pol_words pol_words$sentence pol_words$neutral data.table::as.data.table(pol_words) attributes(extract_sentiment_terms(x))$counts attributes(extract_sentiment_terms(x))$elements ## Not run: library(wordcloud) library(data.table) set.seed(10) x <- get_sentences(sample(hu_liu_cannon_reviews[[2]], 1000, TRUE)) sentiment_words <- extract_sentiment_terms(x) sentiment_counts <- attributes(sentiment_words)$counts sentiment_counts[polarity > 0,] par(mfrow = c(1, 3), mar = c(0, 0, 0, 0)) ## Positive Words with( sentiment_counts[polarity > 0,], wordcloud(words = words, freq = n, min.freq = 1, max.words = 200, random.order = FALSE, rot.per = 0.35, colors = brewer.pal(8, "Dark2"), scale = c(4.5, .75) ) ) mtext("Positive Words", side = 3, padj = 5) ## Negative Words with( sentiment_counts[polarity < 0,], wordcloud(words = words, freq = n, min.freq = 1, max.words = 200, random.order = FALSE, rot.per = 0.35, colors = brewer.pal(8, "Dark2"), scale = c(4.5, 1) ) ) mtext("Negative Words", side = 3, padj = 5) sentiment_counts[, color := ifelse(polarity > 0, 'red', ifelse(polarity < 0, 'blue', 'gray70') )] ## Positive & Negative Together with( sentiment_counts[polarity != 0,], wordcloud(words = words, freq = n, min.freq = 1, max.words = 200, random.order = FALSE, rot.per = 0.35, colors = color, ordered.colors = TRUE, scale = c(5, .75) ) ) mtext("Positive (red) & Negative (blue) Words", side = 3, padj = 5) ## End(Not run)library(data.table) set.seed(10) x <- get_sentences(sample(hu_liu_cannon_reviews[[2]], 1000, TRUE)) sentiment(x) pol_words <- extract_sentiment_terms(x) pol_words pol_words$sentence pol_words$neutral data.table::as.data.table(pol_words) attributes(extract_sentiment_terms(x))$counts attributes(extract_sentiment_terms(x))$elements ## Not run: library(wordcloud) library(data.table) set.seed(10) x <- get_sentences(sample(hu_liu_cannon_reviews[[2]], 1000, TRUE)) sentiment_words <- extract_sentiment_terms(x) sentiment_counts <- attributes(sentiment_words)$counts sentiment_counts[polarity > 0,] par(mfrow = c(1, 3), mar = c(0, 0, 0, 0)) ## Positive Words with( sentiment_counts[polarity > 0,], wordcloud(words = words, freq = n, min.freq = 1, max.words = 200, random.order = FALSE, rot.per = 0.35, colors = brewer.pal(8, "Dark2"), scale = c(4.5, .75) ) ) mtext("Positive Words", side = 3, padj = 5) ## Negative Words with( sentiment_counts[polarity < 0,], wordcloud(words = words, freq = n, min.freq = 1, max.words = 200, random.order = FALSE, rot.per = 0.35, colors = brewer.pal(8, "Dark2"), scale = c(4.5, 1) ) ) mtext("Negative Words", side = 3, padj = 5) sentiment_counts[, color := ifelse(polarity > 0, 'red', ifelse(polarity < 0, 'blue', 'gray70') )] ## Positive & Negative Together with( sentiment_counts[polarity != 0,], wordcloud(words = words, freq = n, min.freq = 1, max.words = 200, random.order = FALSE, rot.per = 0.35, colors = color, ordered.colors = TRUE, scale = c(5, .75) ) ) mtext("Positive (red) & Negative (blue) Words", side = 3, padj = 5) ## End(Not run)
Rescale a numeric vector with the option to make signed (-1, 1, or 0) and retain zero as neutral.
general_rescale( x, lower = -1, upper = 1, mute = NULL, keep.zero = lower < 0, sign = FALSE, ... )general_rescale( x, lower = -1, upper = 1, mute = NULL, keep.zero = lower < 0, sign = FALSE, ... )
x |
A numeric vector. |
lower |
An upper limit to rescale to. |
upper |
A lower limit to rescale to. |
mute |
A positive value greater than 1 to lower the extremes and pull the fractions up. This becomes the denominator in a power to raise each element by (sign is retained) where the numerator is 1. This is useful for mellowing out the extremes. |
keep.zero |
logical. If |
sign |
logical. If |
... |
ignored. |
Returns a rescaled vector of the same length as x.
general_rescale(c(1, 0, -1)) general_rescale(c(1, 0, -1, 1.4, -2)) general_rescale(c(1, 0, -1, 1.4, -2), lower = 0, upper = 1) general_rescale(c(NA, -4:3)) general_rescale(c(NA, -4:3), keep.zero = FALSE) general_rescale(c(NA, -4:3), keep.zero = FALSE, lower = 0, upper = 100) ## mute extreme values set.seed(10) x <- sort(c(NA, -100, -10, 0, rnorm(10, 0, .1), 10, 100), na.last = FALSE) general_rescale(x) general_rescale(x, mute = 5) general_rescale(x, mute = 10) general_rescale(x, mute = 100)general_rescale(c(1, 0, -1)) general_rescale(c(1, 0, -1, 1.4, -2)) general_rescale(c(1, 0, -1, 1.4, -2), lower = 0, upper = 1) general_rescale(c(NA, -4:3)) general_rescale(c(NA, -4:3), keep.zero = FALSE) general_rescale(c(NA, -4:3), keep.zero = FALSE, lower = 0, upper = 100) ## mute extreme values set.seed(10) x <- sort(c(NA, -100, -10, 0, rnorm(10, 0, .1), 10, 100), na.last = FALSE) general_rescale(x) general_rescale(x, mute = 5) general_rescale(x, mute = 10) general_rescale(x, mute = 100)
get_sentences - Get sentences from a character vector, sentiment, or
sentiment_by object.
get_sentences(x, ...)get_sentences(x, ...)
x |
A character vector, |
... |
Other arguments passed to |
Returns a list of vectors of sentences.
dat <- data.frame( w = c('Person 1', 'Person 2'), x = c(paste0( "Mr. Brown comes! He says hello. i give him coffee. i will ", "go at 5 p. m. eastern time. Or somewhere in between!go there" ), "One more thought for the road! I am going now. Good day."), y = state.name[c(32, 38)], z = c(.456, .124), stringsAsFactors = FALSE ) get_sentences(dat$x) get_sentences(dat)dat <- data.frame( w = c('Person 1', 'Person 2'), x = c(paste0( "Mr. Brown comes! He says hello. i give him coffee. i will ", "go at 5 p. m. eastern time. Or somewhere in between!go there" ), "One more thought for the road! I am going now. Good day."), y = state.name[c(32, 38)], z = c(.456, .124), stringsAsFactors = FALSE ) get_sentences(dat$x) get_sentences(dat)
Highlight sentences within elements (row IDs) by sentiment polarity (positive = green; negative = pink) as an html file.
highlight( x, file = file.path(tempdir(), "polarity.html"), open = TRUE, digits = 3, ... )highlight( x, file = file.path(tempdir(), "polarity.html"), open = TRUE, digits = 3, ... )
x |
A |
file |
A name of the html file output. |
open |
logical. If |
digits |
The number of digits to print for each row level average sentiment score. |
... |
Ignored. |
Generates an html document with text highlighting.
## Not run: library(data.table) dat <- presidential_debates_2012 setDT(dat) dat[, gr:={gr= paste(person, time); cumsum(c(TRUE, gr[-1]!= gr[-.N]))}] dat <- dat[, list(person=person[1L], time=time[1L], dialogue=paste(dialogue, collapse = ' ')), by = gr][,gr:= NULL][, dialogue_split := get_sentences(dialogue)][] (sent_dat <- with(dat, sentiment_by(dialogue_split, list(person, time)))) highlight(sent_dat) ## tidy approach library(dplyr) library(magrittr) hu_liu_cannon_reviews %>% filter(review_id %in% sample(unique(review_id), 3)) %>% mutate(review = get_sentences(text)) %$% sentiment_by(review, review_id) %>% highlight() ## End(Not run)## Not run: library(data.table) dat <- presidential_debates_2012 setDT(dat) dat[, gr:={gr= paste(person, time); cumsum(c(TRUE, gr[-1]!= gr[-.N]))}] dat <- dat[, list(person=person[1L], time=time[1L], dialogue=paste(dialogue, collapse = ' ')), by = gr][,gr:= NULL][, dialogue_split := get_sentences(dialogue)][] (sent_dat <- with(dat, sentiment_by(dialogue_split, list(person, time)))) highlight(sent_dat) ## tidy approach library(dplyr) library(magrittr) hu_liu_cannon_reviews %>% filter(review_id %in% sample(unique(review_id), 3)) %>% mutate(review = get_sentences(text)) %$% sentiment_by(review, review_id) %>% highlight() ## End(Not run)
A dataset containing a random sample (n = 5000 of 1,621,956) of Wang, Lu, & Zhai's (2011) hotel reviews data set scraped by the authors from Original URL: http://www.tripadvisor.com.
data(hotel_reviews)data(hotel_reviews)
A data frame with 5000 rows and 2 variables
sentiment. The overall rating for the experience
text. The text review of the hotel
Wang, H., Lu, Y., and Zhai, C. (2011). Latent aspect rating
analysis without aspect keyword supervision. In Proceedings of the 17th ACM
SIGKDD Conference on Knowledge Discovery and Data Mining (KDD'2011), 618-626.
Original URL: 'http://sifaka.cs.uiuc.edu/~wang296/Data/index.html'
A dataset containing Amazon product reviews for the Apex AD2600 Progressive-scan DVD player. This data set was compiled by Hu and Liu (2004). Where a sentence contains more than one opinion score and average of all scores is used.
data(hu_liu_apex_reviews)data(hu_liu_apex_reviews)
A data frame with 740 rows and 3 variables
sentiment. Hu and Liu (2004)'s average opinion rating for a sentence. Negative and positive reflects direction, a negative or positive sentiment. Opinion strength varies between 3 (strongest), and 1 (weakest). number. The review number.
text. The text from the review.
review_id. The review number.
Minqing Hu and Bing Liu. (2004). Mining and summarizing customer reviews. Proceedings of the ACM SIGKDD International Conference on Knowledge Discovery & Data Mining (KDD-04).
Minqing Hu and Bing Liu. (2004)."Mining Opinion Features in Customer Reviews. Proceedings of Nineteeth National Conference on Artificial Intelligence (AAAI-2004).
Original URL: ‘https://www.cs.uic.edu/~liub/FBS/sentiment-analysis.html’
A dataset containing Amazon product reviews for the Cannon G3 Camera. This data set was compiled by Hu and Liu (2004). Where a sentence contains more than one opinion score and average of all scores is used.
data(hu_liu_cannon_reviews)data(hu_liu_cannon_reviews)
A data frame with 597 rows and 3 variables
sentiment. Hu and Liu (2004)'s average opinion rating for a sentence. Negative and positive reflects direction, a negative or positive sentiment. Opinion strength varies between 3 (strongest), and 1 (weakest). number. The review number.
text. The text from the review.
review_id. The review number.
Minqing Hu and Bing Liu. (2004). Mining and summarizing customer reviews. Proceedings of the ACM SIGKDD International Conference on Knowledge Discovery & Data Mining (KDD-04).
Minqing Hu and Bing Liu. (2004)."Mining Opinion Features in Customer Reviews. Proceedings of Nineteeth National Conference on Artificial Intelligence (AAAI-2004).
Original URL: ‘https://www.cs.uic.edu/~liub/FBS/sentiment-analysis.html’
A dataset containing Amazon product reviews for the Creative Labs Nomad Jukebox Zen Xtra 40GB. This data set was compiled by Hu and Liu (2004). Where a sentence contains more than one opinion score and average of all scores is used.
data(hu_liu_jukebox_reviews)data(hu_liu_jukebox_reviews)
A data frame with 1716 rows and 3 variables
sentiment. Hu and Liu (2004)'s average opinion rating for a sentence. Negative and positive reflects direction, a negative or positive sentiment. Opinion strength varies between 3 (strongest), and 1 (weakest). number. The review number.
text. The text from the review.
review_id. The review number.
Minqing Hu and Bing Liu. (2004). Mining and summarizing customer reviews. Proceedings of the ACM SIGKDD International Conference on Knowledge Discovery & Data Mining (KDD-04).
Minqing Hu and Bing Liu. (2004)."Mining Opinion Features in Customer Reviews. Proceedings of Nineteeth National Conference on Artificial Intelligence (AAAI-2004).
Original URL: ‘https://www.cs.uic.edu/~liub/FBS/sentiment-analysis.html’
A dataset containing Amazon product reviews for the Nikon Coolpix 4300. This data set was compiled by Hu and Liu (2004). Where a sentence contains more than one opinion score and average of all scores is used.
data(hu_liu_nikon_reviews)data(hu_liu_nikon_reviews)
A data frame with 346 rows and 3 variables
sentiment. Hu and Liu (2004)'s average opinion rating for a sentence. Negative and positive reflects direction, a negative or positive sentiment. Opinion strength varies between 3 (strongest), and 1 (weakest). number. The review number.
text. The text from the review.
review_id. The review number.
Minqing Hu and Bing Liu. (2004). Mining and summarizing customer reviews. Proceedings of the ACM SIGKDD International Conference on Knowledge Discovery & Data Mining (KDD-04).
Minqing Hu and Bing Liu. (2004)."Mining Opinion Features in Customer Reviews. Proceedings of Nineteeth National Conference on Artificial Intelligence (AAAI-2004).
‘https://www.cs.uic.edu/~liub/FBS/sentiment-analysis.html’
A dataset containing Amazon product reviews for the Nokia 6610. This data set was compiled by Hu and Liu (2004). Where a sentence contains more than one opinion score and average of all scores is used.
data(hu_liu_nokia_reviews)data(hu_liu_nokia_reviews)
A data frame with 546 rows and 3 variables
sentiment. Hu and Liu (2004)'s average opinion rating for a sentence. Negative and positive reflects direction, a negative or positive sentiment. Opinion strength varies between 3 (strongest), and 1 (weakest). number. The review number.
text. The text from the review.
review_id. The review number.
Minqing Hu and Bing Liu. (2004). Mining and summarizing customer reviews. Proceedings of the ACM SIGKDD International Conference on Knowledge Discovery & Data Mining (KDD-04).
Minqing Hu and Bing Liu. (2004)."Mining Opinion Features in Customer Reviews. Proceedings of Nineteeth National Conference on Artificial Intelligence (AAAI-2004).
Original URL: ‘https://www.cs.uic.edu/~liub/FBS/sentiment-analysis.html’
A dataset containing sentiment scored movie reviews from a Kaggle competition posted by University of Michigan SI650. The data was originally collected from opinmind.com.
data(kaggle_movie_reviews)data(kaggle_movie_reviews)
A data frame with 7,086 rows and 2 variables
sentiment. A numeric sentiment score
text. The text from the review
Original URL: https://www.kaggle.com/c/si650winter11/data
A dataset containing a list of 4 review data sets. Each data set contains sentences with a positive (1) or negative review (-1) taken from reviews of products, movies, & restaurants. The data, compiled by Kotzias, Denil, De Freitas, & Smyth (2015), was originally taken from amazon.com, imdb.com, & yelp.com. Kotzias et al. (2015) provide the following description in the README: "For each website, there exist 500 positive and 500 negative sentences. Those were selected randomly for larger datasets of reviews. We attempted to select sentences that have a clearly positive or negative connotation [sic], the goal was for no neutral sentences to be selected. This data set has been manipulated from the original to be split apart by element (sentence split). The original 0/1 metric has also been converted to -1/1. Please cite Kotzias et al. (2015) if you reuse the data here.
data(kotzias_reviews_amazon_cells)data(kotzias_reviews_amazon_cells)
A data frame with 1,067 rows and 2 variables
sentiment. A human scoring of the text.
text. The sentences from the review.
Kotzias, D., Denil, M., De Freitas, N. & Smyth,P. (2015). From group to individual labels using deep features. Proceedings of the 21th ACM SIGKDD International Conference on Knowledge Discovery and Data Mining. 597-606. Original URL: http://mdenil.com/media/papers/2015-deep-multi-instance-learning.pdf
A dataset containing a list of 4 review data sets. Each data set contains sentences with a positive (1) or negative review (-1) taken from reviews of products, movies, & restaurants. The data, compiled by Kotzias, Denil, De Freitas, & Smyth (2015), was originally taken from amazon.com, imdb.com, & yelp.com. Kotzias et al. (2015) provide the following description in the README: "For each website, there exist 500 positive and 500 negative sentences. Those were selected randomly for larger datasets of reviews. We attempted to select sentences that have a clearly positive or negative connotation [sic], the goal was for no neutral sentences to be selected. This data set has been manipulated from the original to be split apart by element (sentence split). The original 0/1 metric has also been converted to -1/1. Please cite Kotzias et al. (2015) if you reuse the data here.
data(kotzias_reviews_imdb)data(kotzias_reviews_imdb)
A data frame with 1,041 rows and 2 variables
sentiment. A human scoring of the text.
text. The sentences from the review.
Kotzias, D., Denil, M., De Freitas, N. & Smyth,P. (2015). From group to individual labels using deep features. Proceedings of the 21th ACM SIGKDD International Conference on Knowledge Discovery and Data Mining. 597-606. Original URL: http://mdenil.com/media/papers/2015-deep-multi-instance-learning.pdf
A dataset containing a list of 4 review data sets. Each data set contains sentences with a positive (1) or negative review (-1) taken from reviews of products, movies, & restaurants. The data, compiled by Kotzias, Denil, De Freitas, & Smyth (2015), was originally taken from amazon.com, imdb.com, & yelp.com. Kotzias et al. (2015) provide the following description in the README: "For each website, there exist 500 positive and 500 negative sentences. Those were selected randomly for larger datasets of reviews. We attempted to select sentences that have a clearly positive or negative connotation [sic], the goal was for no neutral sentences to be selected. This data set has been manipulated from the original to be split apart by element (sentence split). The original 0/1 metric has also been converted to -1/1. Please cite Kotzias et al. (2015) if you reuse the data here.
data(kotzias_reviews_yelp)data(kotzias_reviews_yelp)
A data frame with 1,040 rows and 2 variables
sentiment. A human scoring of the text.
text. The sentences from the review.
Kotzias, D., Denil, M., De Freitas, N. & Smyth,P. (2015). From group to individual labels using deep features. Proceedings of the 21th ACM SIGKDD International Conference on Knowledge Discovery and Data Mining. 597-606. Original URL: http://mdenil.com/media/papers/2015-deep-multi-instance-learning.pdf
A dataset containing Hutto & Gilbert's (2014) sentiment scored New York Times articles.
data(nyt_articles)data(nyt_articles)
A data frame with 5,179 rows and 2 variables
sentiment. A numeric sentiment score
text. The text from the article
Vadar's Liscense:
The MIT License (MIT)
Copyright (c) 2016 C.J. Hutto
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Hutto, C.J. & Gilbert, E.E. (2014). VADER: A Parsimonious Rule-based Model for Sentiment Analysis of Social Media Text. Eighth International Conference on Weblogs and Social Media (ICWSM-14). Ann Arbor, MI, June 2014.
Original URL: https://github.com/cjhutto/vaderSentiment
Plots a emotion object.
## S3 method for class 'emotion' plot( x, transformation.function = syuzhet::get_dct_transform, drop.unused.emotions = TRUE, facet = TRUE, ... )## S3 method for class 'emotion' plot( x, transformation.function = syuzhet::get_dct_transform, drop.unused.emotions = TRUE, facet = TRUE, ... )
x |
The emotion object. |
transformation.function |
A transformation function to smooth the emotion scores. |
drop.unused.emotions |
logical. If |
facet |
logical or one of |
... |
Other arguments passed to |
Utilizes Matthew Jocker's syuzhet package to calculate smoothed emotion across the duration of the text.
Returns a ggplot2 object.
Plots a emotion_by object. Red centers are average emotion. Alpha jittered dots are raw sentence level emotion data. Boxes are boxplots.
## S3 method for class 'emotion_by' plot(x, ordered = TRUE, ...)## S3 method for class 'emotion_by' plot(x, ordered = TRUE, ...)
x |
The emotion_by object. |
ordered |
logical. If |
... |
ignored |
Returns a ggplot2 object.
Plots a profanity object.
## S3 method for class 'profanity' plot(x, transformation.function = syuzhet::get_dct_transform, ...)## S3 method for class 'profanity' plot(x, transformation.function = syuzhet::get_dct_transform, ...)
x |
The profanity object. |
transformation.function |
A transformation function to smooth the profanity scores. |
... |
Other arguments passed to |
Utilizes Matthew Jocker's syuzhet package to calculate smoothed profanity across the duration of the text.
Returns a ggplot2 object.
Plots a profanity_by object. Red centers are average profanity. Alpha jittered dots are raw sentence level profanity data. Boxes are boxplots.
## S3 method for class 'profanity_by' plot(x, ordered = TRUE, ...)## S3 method for class 'profanity_by' plot(x, ordered = TRUE, ...)
x |
The profanity_by object. |
ordered |
logical. If |
... |
ignored |
Returns a ggplot2 object.
Plots a sentiment object.
## S3 method for class 'sentiment' plot(x, transformation.function = syuzhet::get_dct_transform, ...)## S3 method for class 'sentiment' plot(x, transformation.function = syuzhet::get_dct_transform, ...)
x |
The sentiment object. |
transformation.function |
A transformation function to smooth the sentiment scores. |
... |
Other arguments passed to |
Utilizes Matthew Jocker's syuzhet package to calculate smoothed sentiment across the duration of the text.
Returns a ggplot2 object.
Plots a sentiment_by object. Red centers are average sentiment. Alpha jittered dots are raw sentence level sentiment data. Boxes are boxplots.
## S3 method for class 'sentiment_by' plot(x, ordered = TRUE, ...)## S3 method for class 'sentiment_by' plot(x, ordered = TRUE, ...)
x |
The sentiment_by object. |
ordered |
logical. If |
... |
ignored |
Returns a ggplot2 object.
A dataset containing a cleaned version of all three presidential debates for the 2012 election.
data(presidential_debates_2012)data(presidential_debates_2012)
A data frame with 2912 rows and 4 variables
person. The speaker
tot. Turn of talk
dialogue. The words spoken
time. Variable indicating which of the three debates the dialogue is from
Prints an extract_emotion_terms object
## S3 method for class 'extract_emotion_terms' print(x, ...)## S3 method for class 'extract_emotion_terms' print(x, ...)
x |
An extract_emotion_terms object. |
... |
ignored |
Prints an extract_profanity_terms object
## S3 method for class 'extract_profanity_terms' print(x, ...)## S3 method for class 'extract_profanity_terms' print(x, ...)
x |
An extract_profanity_terms object. |
... |
ignored |
Prints an extract_sentiment_terms object
## S3 method for class 'extract_sentiment_terms' print(x, ...)## S3 method for class 'extract_sentiment_terms' print(x, ...)
x |
An extract_sentiment_terms object. |
... |
ignored |
Prints a validate_sentiment object
## S3 method for class 'validate_sentiment' print(x, ...)## S3 method for class 'validate_sentiment' print(x, ...)
x |
A |
... |
ignored. |
Detect the rate of profanity at the sentence level. This method uses a simple
dictionary lookup to find profane words and then compute the rate per sentence.
The profanity score ranges between 0 (no profanity used) and 1 (all
words used were profane). Note that a single profane phrase would count as
just one in the profanity_count column but would count as two words in
the word_count column.
profanity( text.var, profanity_list = unique(tolower(lexicon::profanity_alvarez)), ... )profanity( text.var, profanity_list = unique(tolower(lexicon::profanity_alvarez)), ... )
text.var |
The text variable. Can be a |
profanity_list |
A atomic character vector of profane words. The lexicon package has lists that can be used, including:
|
... |
ignored. |
Returns a data.table of:
element_id - The id number of the original vector passed to profanity
sentence_id - The id number of the sentences within each element_id
word_count - Word count
profanity_count - Count of the number of profane words
profanity - A score of the percentage of profane words
Other profanity functions:
profanity_by()
## Not run: bw <- sample(unique(tolower(lexicon::profanity_alvarez)), 4) mytext <- c( sprintf('do you like this %s? It is %s. But I hate really bad dogs', bw[1], bw[2]), 'I am the best friend.', NA, sprintf('I %s hate this %s', bw[3], bw[4]), "Do you really like it? I'm not happy" ) ## works on a character vector but not the preferred method avoiding the ## repeated cost of doing sentence boundary disambiguation every time ## `profanity` is run profanity(mytext) ## preferred method avoiding paying the cost mytext2 <- get_sentences(mytext) profanity(mytext2) plot(profanity(mytext2)) brady <- get_sentences(crowdflower_deflategate) brady_swears <- profanity(brady) brady_swears ## Distribution of profanity proportion for all comments hist(brady_swears$profanity) sum(brady_swears$profanity > 0) ## Distribution of proportions for those profane comments hist(brady_swears$profanity[brady_swears$profanity > 0]) combo <- combine_data() combo_sentences <- get_sentences(crowdflower_deflategate) racist <- profanity(combo_sentences, profanity_list = lexicon::profanity_racist) combo_sentences[racist$profanity > 0, ]$text extract_profanity_terms( combo_sentences[racist$profanity > 0, ]$text, profanity_list = lexicon::profanity_racist ) ## Remove jerry, que, and illegal from the list library(textclean) racist2 <- profanity( combo_sentences, profanity_list = textclean::drop_element_fixed( lexicon::profanity_racist, c('jerry', 'illegal', 'que') ) ) combo_sentences[racist2$profanity > 0, ]$text ## End(Not run)## Not run: bw <- sample(unique(tolower(lexicon::profanity_alvarez)), 4) mytext <- c( sprintf('do you like this %s? It is %s. But I hate really bad dogs', bw[1], bw[2]), 'I am the best friend.', NA, sprintf('I %s hate this %s', bw[3], bw[4]), "Do you really like it? I'm not happy" ) ## works on a character vector but not the preferred method avoiding the ## repeated cost of doing sentence boundary disambiguation every time ## `profanity` is run profanity(mytext) ## preferred method avoiding paying the cost mytext2 <- get_sentences(mytext) profanity(mytext2) plot(profanity(mytext2)) brady <- get_sentences(crowdflower_deflategate) brady_swears <- profanity(brady) brady_swears ## Distribution of profanity proportion for all comments hist(brady_swears$profanity) sum(brady_swears$profanity > 0) ## Distribution of proportions for those profane comments hist(brady_swears$profanity[brady_swears$profanity > 0]) combo <- combine_data() combo_sentences <- get_sentences(crowdflower_deflategate) racist <- profanity(combo_sentences, profanity_list = lexicon::profanity_racist) combo_sentences[racist$profanity > 0, ]$text extract_profanity_terms( combo_sentences[racist$profanity > 0, ]$text, profanity_list = lexicon::profanity_racist ) ## Remove jerry, que, and illegal from the list library(textclean) racist2 <- profanity( combo_sentences, profanity_list = textclean::drop_element_fixed( lexicon::profanity_racist, c('jerry', 'illegal', 'que') ) ) combo_sentences[racist2$profanity > 0, ]$text ## End(Not run)
Approximate the profanity of text by grouping variable(s). For a
full description of the profanity detection algorithm see
profanity. See profanity
for more details about the algorithm, the profanity/valence shifter keys
that can be passed into the function, and other arguments that can be passed.
profanity_by(text.var, by = NULL, group.names, ...)profanity_by(text.var, by = NULL, group.names, ...)
text.var |
The text variable. Also takes a |
by |
The grouping variable(s). Default |
group.names |
A vector of names that corresponds to group. Generally for internal use. |
... |
Other arguments passed to |
Returns a data.table with grouping variables plus:
element_id - The id number of the original vector passed to profanity
sentence_id - The id number of the sentences within each element_id
word_count - Word count summed by grouping variable
profanity_count - The number of profanities used by grouping variable
sd - Standard deviation (sd) of the sentence level profanity rate by grouping variable
ave_profanity - Profanity rate
See the sentiment_by for details about sentimentr chaining.
Other profanity functions:
profanity()
## Not run: bw <- sample(lexicon::profanity_alvarez, 4) mytext <- c( sprintf('do you like this %s? It is %s. But I hate really bad dogs', bw[1], bw[2]), 'I am the best friend.', NA, sprintf('I %s hate this %s', bw[3], bw[4]), "Do you really like it? I'm not happy" ) ## works on a character vector but not the preferred method avoiding the ## repeated cost of doing sentence boundary disambiguation every time ## `profanity` is run profanity(mytext) profanity_by(mytext) ## preferred method avoiding paying the cost mytext <- get_sentences(mytext) profanity_by(mytext) get_sentences(profanity_by(mytext)) (myprofanity <- profanity_by(mytext)) stats::setNames(get_sentences(profanity_by(mytext)), round(myprofanity[["ave_profanity"]], 3)) brady <- get_sentences(crowdflower_deflategate) library(data.table) bp <- profanity_by(brady) crowdflower_deflategate[bp[ave_profanity > 0,]$element_id, ] vulgars <- bp[["ave_profanity"]] > 0 stats::setNames(get_sentences(bp)[vulgars], round(bp[["ave_profanity"]][vulgars], 3)) bt <- data.table(crowdflower_deflategate)[, source := ifelse(grepl('^RT', text), 'retweet', 'OP')][, belichick := grepl('\\bb[A-Za-z]+l[A-Za-z]*ch', text, ignore.case = TRUE)][] prof_bel <- with(bt, profanity_by(text, by = list(source, belichick))) plot(prof_bel) ## End(Not run)## Not run: bw <- sample(lexicon::profanity_alvarez, 4) mytext <- c( sprintf('do you like this %s? It is %s. But I hate really bad dogs', bw[1], bw[2]), 'I am the best friend.', NA, sprintf('I %s hate this %s', bw[3], bw[4]), "Do you really like it? I'm not happy" ) ## works on a character vector but not the preferred method avoiding the ## repeated cost of doing sentence boundary disambiguation every time ## `profanity` is run profanity(mytext) profanity_by(mytext) ## preferred method avoiding paying the cost mytext <- get_sentences(mytext) profanity_by(mytext) get_sentences(profanity_by(mytext)) (myprofanity <- profanity_by(mytext)) stats::setNames(get_sentences(profanity_by(mytext)), round(myprofanity[["ave_profanity"]], 3)) brady <- get_sentences(crowdflower_deflategate) library(data.table) bp <- profanity_by(brady) crowdflower_deflategate[bp[ave_profanity > 0,]$element_id, ] vulgars <- bp[["ave_profanity"]] > 0 stats::setNames(get_sentences(bp)[vulgars], round(bp[["ave_profanity"]][vulgars], 3)) bt <- data.table(crowdflower_deflategate)[, source := ifelse(grepl('^RT', text), 'retweet', 'OP')][, belichick := grepl('\\bb[A-Za-z]+l[A-Za-z]*ch', text, ignore.case = TRUE)][] prof_bel <- with(bt, profanity_by(text, by = list(source, belichick))) plot(prof_bel) ## End(Not run)
A dataset containing a character vector of the text from Seuss's 'Sam I Am'.
data(sam_i_am)data(sam_i_am)
A character vector with 169 elements
Seuss, Dr. (1960). Green Eggs and Ham.
Approximate the sentiment (polarity) of text by sentence. This function allows
the user to easily alter (add, change, replace) the default polarity an
valence shifters dictionaries to suit the context dependent needs of a particular
data set. See the polarity_dt and valence_shifters_dt arguments
for more information. Other hyper-parameters may add additional fine tuned
control of the algorithm that may boost performance in different contexts.
sentiment( text.var, polarity_dt = lexicon::hash_sentiment_jockers_rinker, valence_shifters_dt = lexicon::hash_valence_shifters, hyphen = "", amplifier.weight = 0.8, n.before = 5, n.after = 2, question.weight = 1, adversative.weight = 0.25, neutral.nonverb.like = FALSE, missing_value = 0, retention_regex = "\\d:\\d|\\d\\s|[^[:alpha:]',;: ]", ... )sentiment( text.var, polarity_dt = lexicon::hash_sentiment_jockers_rinker, valence_shifters_dt = lexicon::hash_valence_shifters, hyphen = "", amplifier.weight = 0.8, n.before = 5, n.after = 2, question.weight = 1, adversative.weight = 0.25, neutral.nonverb.like = FALSE, missing_value = 0, retention_regex = "\\d:\\d|\\d\\s|[^[:alpha:]',;: ]", ... )
text.var |
The text variable. Can be a |
polarity_dt |
A data.table of positive/negative words and weights with x and y as column names. The lexicon package has several dictionaries that can be used, including:
Additionally, the
|
valence_shifters_dt |
A data.table of valence shifters that can alter a polarized word's meaning and an integer key for negators (1), amplifiers [intensifiers] (2), de-amplifiers [downtoners] (3) and adversative conjunctions (4) with x and y as column names. |
hyphen |
The character string to replace hyphens with. Default replaces
with nothing so 'sugar-free' becomes 'sugarfree'. Setting |
amplifier.weight |
The weight to apply to amplifiers/de-amplifiers [intensifiers/downtoners] (values from 0 to 1). This value will multiply the polarized terms by 1 + this value. |
n.before |
The number of words to consider as valence shifters before
the polarized word. To consider the entire beginning portion of a sentence
use |
n.after |
The number of words to consider as valence shifters after
the polarized word. To consider the entire ending portion of a sentence
use |
question.weight |
The weighting of questions (values from 0 to 1). Default is 1. A 0 corresponds with the belief that questions (pure questions) are not polarized. A weight may be applied based on the evidence that the questions function with polarized sentiment. In an opinion tasks such as a course evalaution the questions are more likely polarized, not designed to gain information. On the other hand, in a setting with more natural dialogue, the question is less likely polarized and is likely to function as a means to gather information. |
adversative.weight |
The weight to give to adversative conjunctions or
contrasting conjunctions (e.g., "but") that overrule the previous clause
(Halliday & Hasan, 2013). Weighting a contrasting statement stems from the
belief that the adversative conjunctions like "but", "however", and "although"
amplify the current clause and/or down weight the prior clause. If an
adversative conjunction is located before the polarized word in the context
cluster the cluster is up-weighted 1 + number of occurrences of the
adversative conjunctions before the polarized word times the
weight given ( |
neutral.nonverb.like |
logical. If |
missing_value |
A value to replace |
retention_regex |
A regex of what characters to keep. All other
characters will be removed. Note that when this is used all text is lower
case format. Only adjust this parameter if you really understand how it is
used. Note that swapping the |
... |
Ignored. |
The equation used by the algorithm to assign value to polarity of
each sentence fist utilizes the sentiment dictionary to tag polarized words.
Each paragraph
() composed of
sentences, is broken into element sentences
() where
are the words within sentences. Each sentence () is broken into a
an ordered bag of words. Punctuation is removed with the exception of pause
punctuations (commas, colons, semicolons) which are considered a word within
the sentence. I will denote pause words as (comma words) for
convenience. We can represent these words as an i,j,k notation as
. For example would be the fifth word of the
second sentence of the third paragraph. While I use the term paragraph this
merely represent a complete turn of talk. For example t may be a cell level
response in a questionnaire composed of sentences.
The words in each sentence () are searched and compared to a
dictionary of polarized words (e.g., Jockers (2017) dictionary found in
the lexicon package). Positive () and
negative () words are tagged with a
and respectively. I will denote polarized words as for
convenience. These will form a polar cluster ()
which is a subset of the a sentence
().
The polarized context cluster () of words is pulled from around
the polarized word () and defaults to 4 words before and two words
after ) to be considered as valence shifters. The cluster can be represented as
(),
where & are the parameters n.before and n.after
set by the user. The words in this polarized context cluster are tagged as
neutral (), negator (),
amplifier [intensifier]] (), or de-amplifier
[downtoner] (). Neutral words hold no value in
the equation but do affect word count (). Each polarized word is then
weighted () based on the weights from the polarity_dt argument
and then further weighted by the function and number of the valence shifters
directly surrounding the positive or negative word (). Pause
() locations (punctuation that denotes a pause including commas,
colons, and semicolons) are indexed and considered in calculating the upper
and lower bounds in the polarized context cluster. This is because these marks
indicate a change in thought and words prior are not necessarily connected
with words after these punctuation marks. The lower bound of the polarized
context cluster is constrained to
and the upper bound is
constrained to
where is the number of words in the sentence.
The core value in the cluster, the polarized word is acted upon by valence
shifters. Amplifiers (intensifiers) increase the polarity by 1.8 (.8 is the default weight
()). Amplifiers () become de-amplifiers if the context
cluster contains an odd number of negators (). De-amplifiers
(downtoners) work to decrease the polarity. Negation () acts on
amplifiers/de-amplifiers as discussed but also flip the sign of the polarized
word. Negation is determined by raising -1 to the power of the number of
negators () + 2. Simply, this is a result of a belief that two
negatives equal a positive, 3 negatives a negative and so on.
The adversative conjunctions (i.e., 'but', 'however', and 'although') also
weight the context cluster. A adversative conjunction before the polarized
word () up-weights
the cluster by
(.85 is the default weight ()). An adversative conjunction after
the polarized word down-weights the cluster by
.
The number of occurrences before and after the polarized word are multiplied by
1 and -1 respectively and then summed within context cluster. It is this
value that is multiplied by the weight and added to 1. This
corresponds to the belief that an adversative conjunction makes the next
clause of greater values while lowering the value placed on the prior clause.
The researcher may provide a weight to be utilized with
amplifiers/de-amplifiers (default is .8; de-amplifier weight is constrained
to -1 lower bound). Last, these weighted context clusters () are
summed () and divided by the square root of the word count () yielding an unbounded
polarity score () for each sentence.
Where:
Returns a data.table of:
element_id - The id number of the original vector passed to sentiment
sentence_id - The id number of the sentences within each element_id
word_count - Word count
sentiment - Sentiment/polarity score (note: sentiments less than zero is negative, 0 is neutral, and greater than zero positive polarity)
The polarity score is dependent upon the polarity dictionary used.
This function defaults to a combined and augmented version of Jocker's (2017)
[originally exported by the syuzhet package] & Rinker's augmented Hu & Liu (2004)
dictionaries in the lexicon package, however, this may not be appropriate, for
example, in the context of children in a classroom. The user may (is
encouraged) to provide/augment the dictionary (see the as_key
function). For instance the word "sick" in a high school setting may mean
that something is good, whereas "sick" used by a typical adult indicates
something is not right or negative connotation (deixis).
Jockers, M. L. (2017). Syuzhet: Extract sentiment and plot arcs from text. Retrieved from https://github.com/mjockers/syuzhet
Hu, M., & Liu, B. (2004). Mining opinion features in customer reviews. National Conference on Artificial Intelligence.
Halliday, M. A. K. & Hasan, R. (2013). Cohesion in English. New York, NY: Routledge.
https://www.slideshare.net/jeffreybreen/r-by-example-mining-twitter-for
http://hedonometer.org/papers.html Links to papers on hedonometrics
Original URL: https://github.com/trestletech/Sermon-Sentiment-Analysis
Other sentiment functions:
sentiment_by()
mytext <- c( 'do you like it? But I hate really bad dogs', 'I am the best friend.', "Do you really like it? I'm not a fan", "It's like a tree." ) ## works on a character vector but not the preferred method avoiding the ## repeated cost of doing sentence boundary disambiguation every time ## `sentiment` is run. For small batches the loss is minimal. ## Not run: sentiment(mytext) ## End(Not run) ## preferred method avoiding paying the cost mytext <- get_sentences(mytext) sentiment(mytext) sentiment(mytext, question.weight = 0) sam_dat <- get_sentences(gsub("Sam-I-am", "Sam I am", sam_i_am)) (sam <- sentiment(sam_dat)) plot(sam) plot(sam, scale_range = TRUE, low_pass_size = 5) plot(sam, scale_range = TRUE, low_pass_size = 10) ## Not run: ## legacy transform functions from suuzhet plot(sam, transformation.function = syuzhet::get_transformed_values) plot(sam, transformation.function = syuzhet::get_transformed_values, scale_range = TRUE, low_pass_size = 5) ## End(Not run) y <- get_sentences( "He was not the sort of man that one would describe as especially handsome." ) sentiment(y) sentiment(y, n.before=Inf) ## Not run: ## Categorize the polarity (tidyverse vs. data.table): library(dplyr) sentiment(mytext) %>% as_tibble() %>% mutate(category = case_when( sentiment < 0 ~ 'Negative', sentiment == 0 ~ 'Neutral', sentiment > 0 ~ 'Positive' ) %>% factor(levels = c('Negative', 'Neutral', 'Positive')) ) library(data.table) dt <- sentiment(mytext)[, category := factor(fcase( sentiment < 0, 'Negative', sentiment == 0, 'Neutral', sentiment > 0, 'Positive' ), levels = c('Negative', 'Neutral', 'Positive'))][] dt ## End(Not run) dat <- data.frame( w = c('Person 1', 'Person 2'), x = c(paste0( "Mr. Brown is nasty! He says hello. i give him rage. i will ", "go at 5 p. m. eastern time. Angry thought in between!go there" ), "One more thought for the road! I am going now. Good day and good riddance."), y = state.name[c(32, 38)], z = c(.456, .124), stringsAsFactors = FALSE ) sentiment(get_sentences(dat$x)) sentiment(get_sentences(dat)) ## Not run: ## tidy approach library(dplyr) library(magrittr) hu_liu_cannon_reviews %>% mutate(review_split = get_sentences(text)) %$% sentiment(review_split) ## End(Not run) ## Emojis ## Not run: ## Load R twitter data x <- read.delim(system.file("docs/r_tweets.txt", package = "textclean"), stringsAsFactors = FALSE) x library(dplyr); library(magrittr) ## There are 2 approaches ## Approach 1: Replace with words x %>% mutate(Tweet = replace_emoji(Tweet)) %$% sentiment(Tweet) ## Approach 2: Replace with identifier token combined_emoji <- update_polarity_table( lexicon::hash_sentiment_jockers_rinker, x = lexicon::hash_sentiment_emojis ) x %>% mutate(Tweet = replace_emoji_identifier(Tweet)) %$% sentiment(Tweet, polarity_dt = combined_emoji) ## Use With Non-ASCII ## Warning: sentimentr has not been tested with languages other than English. ## The example below is how one might use sentimentr if you believe the ## language you are working with are similar enough in grammar to for ## sentimentr to be viable (likely Germanic languages) ## english_sents <- c( ## "I hate bad people.", ## "I like yummy cookie.", ## "I don't love you anymore; sorry." ## ) ## Roughly equivalent to the above English danish_sents <- stringi::stri_unescape_unicode(c( "Jeg hader d\\u00e5rlige mennesker.", "Jeg kan godt lide l\\u00e6kker is.", "Jeg elsker dig ikke mere; undskyld." )) danish_sents ## Polarity terms polterms <- stringi::stri_unescape_unicode( c('hader', 'd\\u00e5rlige', 'undskyld', 'l\\u00e6kker', 'kan godt', 'elsker') ) ## Make polarity_dt danish_polarity <- as_key(data.frame( x = stringi::stri_unescape_unicode(polterms), y = c(-1, -1, -1, 1, 1, 1) )) ## Make valence_shifters_dt danish_valence_shifters <- as_key( data.frame(x='ikke', y="1"), sentiment = FALSE, comparison = NULL ) sentiment( danish_sents, polarity_dt = danish_polarity, valence_shifters_dt = danish_valence_shifters, retention_regex = "\\d:\\d|\\d\\s|[^\\p{L}',;: ]" ) ## A way to test if you need [:alpha:] vs \p{L} in `retention_regex`: ## 1. Does it wreck some of the non-ascii characters by default? sentimentr:::make_sentence_df2(danish_sents) ## 2.Does this? sentimentr:::make_sentence_df2(danish_sents, "\\d:\\d|\\d\\s|[^\\p{L}',;: ]") ## If you answer yes to #1 but no to #2 you likely want \p{L} ## End(Not run)mytext <- c( 'do you like it? But I hate really bad dogs', 'I am the best friend.', "Do you really like it? I'm not a fan", "It's like a tree." ) ## works on a character vector but not the preferred method avoiding the ## repeated cost of doing sentence boundary disambiguation every time ## `sentiment` is run. For small batches the loss is minimal. ## Not run: sentiment(mytext) ## End(Not run) ## preferred method avoiding paying the cost mytext <- get_sentences(mytext) sentiment(mytext) sentiment(mytext, question.weight = 0) sam_dat <- get_sentences(gsub("Sam-I-am", "Sam I am", sam_i_am)) (sam <- sentiment(sam_dat)) plot(sam) plot(sam, scale_range = TRUE, low_pass_size = 5) plot(sam, scale_range = TRUE, low_pass_size = 10) ## Not run: ## legacy transform functions from suuzhet plot(sam, transformation.function = syuzhet::get_transformed_values) plot(sam, transformation.function = syuzhet::get_transformed_values, scale_range = TRUE, low_pass_size = 5) ## End(Not run) y <- get_sentences( "He was not the sort of man that one would describe as especially handsome." ) sentiment(y) sentiment(y, n.before=Inf) ## Not run: ## Categorize the polarity (tidyverse vs. data.table): library(dplyr) sentiment(mytext) %>% as_tibble() %>% mutate(category = case_when( sentiment < 0 ~ 'Negative', sentiment == 0 ~ 'Neutral', sentiment > 0 ~ 'Positive' ) %>% factor(levels = c('Negative', 'Neutral', 'Positive')) ) library(data.table) dt <- sentiment(mytext)[, category := factor(fcase( sentiment < 0, 'Negative', sentiment == 0, 'Neutral', sentiment > 0, 'Positive' ), levels = c('Negative', 'Neutral', 'Positive'))][] dt ## End(Not run) dat <- data.frame( w = c('Person 1', 'Person 2'), x = c(paste0( "Mr. Brown is nasty! He says hello. i give him rage. i will ", "go at 5 p. m. eastern time. Angry thought in between!go there" ), "One more thought for the road! I am going now. Good day and good riddance."), y = state.name[c(32, 38)], z = c(.456, .124), stringsAsFactors = FALSE ) sentiment(get_sentences(dat$x)) sentiment(get_sentences(dat)) ## Not run: ## tidy approach library(dplyr) library(magrittr) hu_liu_cannon_reviews %>% mutate(review_split = get_sentences(text)) %$% sentiment(review_split) ## End(Not run) ## Emojis ## Not run: ## Load R twitter data x <- read.delim(system.file("docs/r_tweets.txt", package = "textclean"), stringsAsFactors = FALSE) x library(dplyr); library(magrittr) ## There are 2 approaches ## Approach 1: Replace with words x %>% mutate(Tweet = replace_emoji(Tweet)) %$% sentiment(Tweet) ## Approach 2: Replace with identifier token combined_emoji <- update_polarity_table( lexicon::hash_sentiment_jockers_rinker, x = lexicon::hash_sentiment_emojis ) x %>% mutate(Tweet = replace_emoji_identifier(Tweet)) %$% sentiment(Tweet, polarity_dt = combined_emoji) ## Use With Non-ASCII ## Warning: sentimentr has not been tested with languages other than English. ## The example below is how one might use sentimentr if you believe the ## language you are working with are similar enough in grammar to for ## sentimentr to be viable (likely Germanic languages) ## english_sents <- c( ## "I hate bad people.", ## "I like yummy cookie.", ## "I don't love you anymore; sorry." ## ) ## Roughly equivalent to the above English danish_sents <- stringi::stri_unescape_unicode(c( "Jeg hader d\\u00e5rlige mennesker.", "Jeg kan godt lide l\\u00e6kker is.", "Jeg elsker dig ikke mere; undskyld." )) danish_sents ## Polarity terms polterms <- stringi::stri_unescape_unicode( c('hader', 'd\\u00e5rlige', 'undskyld', 'l\\u00e6kker', 'kan godt', 'elsker') ) ## Make polarity_dt danish_polarity <- as_key(data.frame( x = stringi::stri_unescape_unicode(polterms), y = c(-1, -1, -1, 1, 1, 1) )) ## Make valence_shifters_dt danish_valence_shifters <- as_key( data.frame(x='ikke', y="1"), sentiment = FALSE, comparison = NULL ) sentiment( danish_sents, polarity_dt = danish_polarity, valence_shifters_dt = danish_valence_shifters, retention_regex = "\\d:\\d|\\d\\s|[^\\p{L}',;: ]" ) ## A way to test if you need [:alpha:] vs \p{L} in `retention_regex`: ## 1. Does it wreck some of the non-ascii characters by default? sentimentr:::make_sentence_df2(danish_sents) ## 2.Does this? sentimentr:::make_sentence_df2(danish_sents, "\\d:\\d|\\d\\s|[^\\p{L}',;: ]") ## If you answer yes to #1 but no to #2 you likely want \p{L} ## End(Not run)
This function utilizes gofastr and termco to extract sentiment based attributes (attributes concerning polarized words and valence shifters) from a text. Attributes include the rate of polarized terms and valence shifters relative to number of words. Additionally, coocurrence rates for valence shifters are computed.
sentiment_attributes( text.var, polarity_dt = lexicon::hash_sentiment_jockers_rinker, valence_shifters_dt = lexicon::hash_valence_shifters, ... )sentiment_attributes( text.var, polarity_dt = lexicon::hash_sentiment_jockers_rinker, valence_shifters_dt = lexicon::hash_valence_shifters, ... )
text.var |
The text variable. |
polarity_dt |
A data.table of positive/negative words and weights with x and y as column names. |
valence_shifters_dt |
A data.table of valence shifters that can alter a polarized word's meaning and an integer key for negators (1), amplifiers(2), de-amplifiers (3) and adversative conjunctions (4) with x and y as column names. |
... |
ignored. |
Returns a list of four items:
Meta |
The number of words, sentences, and questions in the text |
Attributes |
The rate of sentiment attributes relative to the number of words |
Polarized_Cooccurrences |
The rate that valence shifters cooccur with a polarized word in the same sentence |
Cooccurrences |
A cooccurrence matrix of sentiment attributes; 'polarized' is the sum of positive and negative |
gofastr and termco must be installed. If they are not (which
they are not part of sentimentr install) then the function will prompt
you to attempt to install them using install.packages and
ghit::install_github.
## Not run: sentiment_attributes(presidential_debates_2012$dialogue) ## End(Not run)## Not run: sentiment_attributes(presidential_debates_2012$dialogue) ## End(Not run)
Approximate the sentiment (polarity) of text by grouping variable(s). For a
full description of the sentiment detection algorithm see
sentiment. See sentiment
for more details about the algorithm, the sentiment/valence shifter keys
that can be passed into the function, and other arguments that can be passed.
sentiment_by( text.var, by = NULL, averaging.function = sentimentr::average_downweighted_zero, group.names, ... )sentiment_by( text.var, by = NULL, averaging.function = sentimentr::average_downweighted_zero, group.names, ... )
text.var |
The text variable. Also takes a |
by |
The grouping variable(s). Default |
averaging.function |
A function for performing the group by averaging.
The default, |
group.names |
A vector of names that corresponds to group. Generally for internal use. |
... |
Other arguments passed to |
Returns a data.table with grouping variables plus:
element_id - The id number of the original vector passed to sentiment
sentence_id - The id number of the sentences within each element_id
word_count - Word count summed by grouping variable
sd - Standard deviation (sd) of the sentiment/polarity score by grouping variable
ave_sentiment - Sentiment/polarity score mean average by grouping variable
sentimentr uses non-standard evaluation when you use with() OR
%$% (magrittr) and looks for the vectors within the data set
passed to it. There is one exception to this...when you pass a
get_sentences() object to sentiment_by() to the first argument
which is text.var it calls the sentiment_by.get_sentences_data_frame
method which requires text.var to be a get_sentences_data_frame
object. Because this object is a data.frame its method knows this and
knows it can access the columns of the get_sentences_data_frame object
directly (usually text.var is an atomic vector), it just needs the
names of the columns to grab.
To illustrate this point understand that all three of these approaches result in exactly the same output:
## method 1
presidential_debates_2012 %>%
get_sentences() %>%
sentiment_by(by = c('person', 'time'))
## method 2
presidential_debates_2012 %>%
get_sentences() %$%
sentiment_by(., by = c('person', 'time'))
## method 3
presidential_debates_2012 %>%
get_sentences() %$%
sentiment_by(dialogue, by = list(person, time))
Also realize that a get_sentences_data_frame object also has a column
with a get_sentences_character class column which also has a method in
sentimentr.
When you use with() OR %$% then you're not actually passing
the get_sentences_data_frame object to sentimentr and hence the
sentiment_by.get_sentences_data_frame method isn't called rather
sentiment_by is evaluated in the environment/data of the
get_sentences_data_frame object. You can force the object passed this
way to be evaluated as a get_sentences_data_frame object and thus
calling the sentiment_by.get_sentences_data_frame method by using the
. operator as I've done in method 2 above. Otherwise you pass the name
of the text column which is actually a get_sentences_character class
and it calls its own method. In this case the by argument expects vectors or
a list of vectors and since it's being evaluated within the data set you can
use list().
Other sentiment functions:
sentiment()
mytext <- c( 'do you like it? It is red. But I hate really bad dogs', 'I am the best friend.', "Do you really like it? I'm not happy" ) ## works on a character vector but not the preferred method avoiding the ## repeated cost of doing sentence boundary disambiguation every time ## `sentiment` is run ## Not run: sentiment(mytext) sentiment_by(mytext) ## End(Not run) ## preferred method avoiding paying the cost mytext <- get_sentences(mytext) sentiment_by(mytext) sentiment_by(mytext, averaging.function = average_mean) sentiment_by(mytext, averaging.function = average_weighted_mixed_sentiment) get_sentences(sentiment_by(mytext)) (mysentiment <- sentiment_by(mytext, question.weight = 0)) stats::setNames(get_sentences(sentiment_by(mytext, question.weight = 0)), round(mysentiment[["ave_sentiment"]], 3)) pres_dat <- get_sentences(presidential_debates_2012) ## Not run: ## less optimized way with(presidential_debates_2012, sentiment_by(dialogue, person)) ## End(Not run) ## Not run: sentiment_by(pres_dat, 'person') (out <- sentiment_by(pres_dat, c('person', 'time'))) plot(out) plot(uncombine(out)) sentiment_by(out, presidential_debates_2012$person) with(presidential_debates_2012, sentiment_by(out, time)) highlight(with(presidential_debates_2012, sentiment_by(out, list(person, time)))) ## End(Not run) ## Not run: ## tidy approach library(dplyr) library(magrittr) hu_liu_cannon_reviews %>% mutate(review_split = get_sentences(text)) %$% sentiment_by(review_split) ## End(Not run)mytext <- c( 'do you like it? It is red. But I hate really bad dogs', 'I am the best friend.', "Do you really like it? I'm not happy" ) ## works on a character vector but not the preferred method avoiding the ## repeated cost of doing sentence boundary disambiguation every time ## `sentiment` is run ## Not run: sentiment(mytext) sentiment_by(mytext) ## End(Not run) ## preferred method avoiding paying the cost mytext <- get_sentences(mytext) sentiment_by(mytext) sentiment_by(mytext, averaging.function = average_mean) sentiment_by(mytext, averaging.function = average_weighted_mixed_sentiment) get_sentences(sentiment_by(mytext)) (mysentiment <- sentiment_by(mytext, question.weight = 0)) stats::setNames(get_sentences(sentiment_by(mytext, question.weight = 0)), round(mysentiment[["ave_sentiment"]], 3)) pres_dat <- get_sentences(presidential_debates_2012) ## Not run: ## less optimized way with(presidential_debates_2012, sentiment_by(dialogue, person)) ## End(Not run) ## Not run: sentiment_by(pres_dat, 'person') (out <- sentiment_by(pres_dat, c('person', 'time'))) plot(out) plot(uncombine(out)) sentiment_by(out, presidential_debates_2012$person) with(presidential_debates_2012, sentiment_by(out, time)) highlight(with(presidential_debates_2012, sentiment_by(out, list(person, time)))) ## End(Not run) ## Not run: ## tidy approach library(dplyr) library(magrittr) hu_liu_cannon_reviews %>% mutate(review_split = get_sentences(text)) %$% sentiment_by(review_split) ## End(Not run)
Calculate text polarity sentiment in the English language at the sentence level and optionally aggregate by rows or grouping variable(s).
sentiment_by Object to the Sentence LevelUngroup a sentiment_by object, stretching to the element_id and
sentence_id levels.
uncombine(x, ...)uncombine(x, ...)
x |
A |
... |
Ignored. |
Returns a data.table with grouping variables plus:
element_id - The id number of the original vector passed to sentiment
word_count - Word count summed by grouping variable
sd - Standard deviation (sd) of the sentiment/polarity score by grouping variable
ave_sentiment - Sentiment/polarity score mean average by grouping variable
mytext <- c( 'do you like it? But I hate really bad dogs', 'I am the best friend.', "Do you really like it? I'm not happy" ) mytext <- get_sentences(mytext) (x <- sentiment_by(mytext)) uncombine(x) ## Not run: (y <- with( presidential_debates_2012, sentiment_by( text.var = get_sentences(dialogue), by = list(person, time) ) )) uncombine(y) ## End(Not run)mytext <- c( 'do you like it? But I hate really bad dogs', 'I am the best friend.', "Do you really like it? I'm not happy" ) mytext <- get_sentences(mytext) (x <- sentiment_by(mytext)) uncombine(x) ## Not run: (y <- with( presidential_debates_2012, sentiment_by( text.var = get_sentences(dialogue), by = list(person, time) ) )) uncombine(y) ## End(Not run)
Provides a multiclass macroaverage/microaverage of precision, recall, accuracy, and F-score for the sign of the predicted sentiment against known sentiment scores. There are three classes sentiment analysis generally predicts: positive (> 0), negative (< 0) and neutral (= 0). In assessing model performance one can use macro- or micro- averaging across classes. Macroaveraging allows every class to have an equal say. Microaveraging gives larger say to larger classes.
validate_sentiment(predicted, actual, ...)validate_sentiment(predicted, actual, ...)
predicted |
A numeric vector of predicted sentiment scores or a sentimentr object that returns sentiment scores. |
actual |
A numeric vector of known sentiment ratings. |
... |
ignored. |
Returns a data.frame with a macroaveraged and
microaveraged model validation scores. Additionally, the
data.frame has the following attributes:
confusion_matrix |
A confusion matrix of all classes |
class_confusion_matrices |
A |
macro_stats |
A |
mda |
Mean Directional Accuracy |
mare |
Mean Absolute Rescaled Error |
Mean Absolute Rescaled Error (MARE) is defined as:
and gives a sense of, on average,
how far off were the rescaled predicted values (-1 to 1) from the rescaled
actual values (-1 to 1). A value of 0 means perfect accuracy. A value of
1 means perfectly wrong every time. A value of .5 represents expected value
for random guessing. This measure is related to
Mean Absolute Error.
https://www.youtube.com/watch?v=OwwdYHWRB5E&index=31&list=PL6397E4B26D00A269
https://en.wikipedia.org/wiki/Mean_Directional_Accuracy_(MDA)
actual <- c(1, 1, 1, 1, -1, -1, -1, -1, -1, -1, -1, 1,-1) predicted <- c(1, 0, 1, -1, 1, 0, -1, -1, -1, -1, 0, 1,-1) validate_sentiment(predicted, actual) scores <- hu_liu_cannon_reviews$sentiment mod <- sentiment_by(get_sentences(hu_liu_cannon_reviews$text)) validate_sentiment(mod$ave_sentiment, scores) validate_sentiment(mod, scores) x <- validate_sentiment(mod, scores) attributes(x)$confusion_matrix attributes(x)$class_confusion_matrices attributes(x)$macro_stats ## Annie Swafford Example swafford <- data.frame( text = c( "I haven't been sad in a long time.", "I am extremely happy today.", "It's a good day.", "But suddenly I'm only a little bit happy.", "Then I'm not happy at all.", "In fact, I am now the least happy person on the planet.", "There is no happiness left in me.", "Wait, it's returned!", "I don't feel so bad after all!" ), actual = c(.8, 1, .8, -.1, -.5, -1, -1, .5, .6), stringsAsFactors = FALSE ) pred <- sentiment_by(swafford$text) validate_sentiment( pred, actual = swafford$actual )actual <- c(1, 1, 1, 1, -1, -1, -1, -1, -1, -1, -1, 1,-1) predicted <- c(1, 0, 1, -1, 1, 0, -1, -1, -1, -1, 0, 1,-1) validate_sentiment(predicted, actual) scores <- hu_liu_cannon_reviews$sentiment mod <- sentiment_by(get_sentences(hu_liu_cannon_reviews$text)) validate_sentiment(mod$ave_sentiment, scores) validate_sentiment(mod, scores) x <- validate_sentiment(mod, scores) attributes(x)$confusion_matrix attributes(x)$class_confusion_matrices attributes(x)$macro_stats ## Annie Swafford Example swafford <- data.frame( text = c( "I haven't been sad in a long time.", "I am extremely happy today.", "It's a good day.", "But suddenly I'm only a little bit happy.", "Then I'm not happy at all.", "In fact, I am now the least happy person on the planet.", "There is no happiness left in me.", "Wait, it's returned!", "I don't feel so bad after all!" ), actual = c(.8, 1, .8, -.1, -.5, -1, -1, .5, .6), stringsAsFactors = FALSE ) pred <- sentiment_by(swafford$text) validate_sentiment( pred, actual = swafford$actual )