R/get_text.R

In trinker/clustext: Consistent Clustering for Text Data

#' Get a Text Stored in Various Objects
#'
#' Extract the text supplied to the
#' \code{\link[clustext]{hierarchical_cluster}} object.
#'
#' @param x A \code{\link[clustext]{hierarchical_cluster}} object.
#' @param \ldots ignored.
#' @return Returns a vector or list of text strings.
#' @export
#' @rdname get_text
#' @examples
#' library(dplyr)
#'
#' presidential_debates_2012 %>%
#'     with(data_store(dialogue)) %>%
#'     hierarchical_cluster() %>%
#'     get_text() %>%
#'     head()
get_text <- function(x, ...){
    UseMethod("get_text")
}


#' @export
#' @rdname get_text
#' @method get_text default
get_text.default <- function(x, ...){
    termco::get_text(x, ...)
}


#' @export
#' @rdname get_text
#' @method get_text hierarchical_cluster
get_text.hierarchical_cluster <- function(x, ...){
    get_text(attributes(x)[["text_data_store"]][["data"]])
}


#' @export
#' @rdname get_text
#' @method get_text kmeans_cluster
get_text.kmeans_cluster <- function(x, ...){
    get_text(attributes(x)[["text_data_store"]][["data"]])
}


#' @export
#' @rdname get_text
#' @method get_text nmf_cluster
get_text.nmf_cluster <- function(x, ...){
    get_text(attributes(x)[["text_data_store"]][["data"]])
}


#' @export
#' @rdname get_text
#' @method get_text skmeans_cluster
get_text.skmeans_cluster <- function(x, ...){
    get_text(attributes(x)[["text_data_store"]][["data"]])
}




#' @export
#' @rdname get_text
#' @method get_text data_store
get_text.data_store <- function(x, ...){
    x[["text"]]
}


#' @export
#' @rdname get_text
#' @method get_text assign_cluster
get_text.assign_cluster <- function(x, ...){
    split(get_text(attributes(x)[["data_store"]][["data"]]), as.integer(x))
}