R/uncombine.R

In sentimentr: Calculate Text Polarity Sentiment

#' Ungroup a \code{sentiment_by} Object to the Sentence Level
#'
#' Ungroup a \code{sentiment_by} object, stretching to the \code{element_id} and
#' \code{sentence_id} levels.
#'
#' @param x A \code{sentiment_by} object.
#' @param \ldots Ignored.
#' @return Returns a \pkg{data.table} with grouping variables plus:
#' \itemize{
#'   \item  element_id - The id number of the original vector passed to \code{sentiment}
#'   \item  word_count - Word count \code{\link[base]{sum}}med by grouping variable
#'   \item  sd - Standard deviation (\code{\link[stats]{sd}}) of the sentiment/polarity score by grouping variable
#'   \item  ave_sentiment - Sentiment/polarity score \code{\link[base]{mean}} average by grouping variable
#' }
#' @export
#' @examples
#' 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)
#'
#' \dontrun{
#' (y <- with(
#'     presidential_debates_2012, 
#'     sentiment_by(
#'         text.var = get_sentences(dialogue), 
#'         by = list(person, time)
#'     )
#' ))
#' uncombine(y)
#' }
uncombine <- function(x, ...){
     UseMethod("uncombine")
}

#' @export
#' @method uncombine sentiment_by
uncombine.sentiment_by <- function(x, ...){
    out <- attributes(x)[["uncombine"]][["uncombine"]]

    class(out) <- unique(c("sentiment", class(out)))

    sentences <- new.env(FALSE)
    sentences[["sentences"]] <- get_sentences(x)
    attributes(out)[["sentences"]] <- sentences
    out
}


#' @export
#' @method uncombine profanity_by
uncombine.profanity_by <- function(x, ...){
    out <- attributes(x)[["uncombine"]][["uncombine"]]

    class(out) <- unique(c("profanity", class(out)))

    sentences <- new.env(FALSE)
    sentences[["sentences"]] <- get_sentences(x)
    attributes(out)[["sentences"]] <- sentences
    out
}


#' @export
#' @method uncombine emotion_by
uncombine.emotion_by <- function(x, ...){
    out <- attributes(x)[["uncombine"]][["uncombine"]]

    class(out) <- unique(c("emotion", class(out)))

    sentences <- new.env(FALSE)
    sentences[["sentences"]] <- get_sentences(x)
    attributes(out)[["sentences"]] <- sentences
    out
}