R/weight.R

In trinker/termco: Counts of Terms and Substrings

#' Weight Term Counts from \code{term_count}
#'
#' Weight term counts from \code{\link[termco]{term_count}} object.
#'
#' @param x A \code{\link[termco]{term_count}} object.
#' @param weight A weight to use.   Currently the following are available:
#' \code{"proportion"}, \code{"percent"}.
#' @param \ldots ignored
#' @return Returns a weighted \code{tibble::tibble} object of term counts
#' by grouping variable.
#' @keywords weight
#' @export
#' @examples
#' library(dplyr)
#' data(markers)
#'
#' weight(markers, "percent") %>%
#'     arrange(desc(n.words))
#'
#' weight(markers, 'proportion')
weight <- function(x, weight = "percent", ...){
    UseMethod('weight')
}

#' @export
#' @rdname weight
#' @method weight term_count
weight.term_count <- function(x, weight = "percent", ...){

    switch(weight,
        percent = propify(x, perc),
        proportion = propify(x, prop),
        stop("Select an appropriate weighting method")
    )
}

#' @export
#' @rdname weight
#' @method weight token_count
weight.token_count <- function(x, weight = "percent", ...){

    switch(weight,
        percent = propify_token(x, perc),
        proportion = propify_token(x, prop),
        stop("Select an appropriate weighting method")
    )
}