R/MakeTimeSeries.R

In jdjohn215/MLSPTools: Internal tools for use with the Marquette Law Poll

#' Make a time series of a variable
#'
#' \code{time_series} returns a data.frame containing a time series of a variable
#'
#'  This is a wrapper around pollster::crosstab in which x is assumed to be zpollenddate.
#'  All you have to provide is the y-var to the `variable` argument
#'
#' @param mulaw The data.frame containing the version of the integrated file you wish to use
#' @param variable The variable
#' @param date the date variable, defaults to zpollenddate
#' @param weight The weighting variable, defaults to zwave_weight
#' @param remove An optional character vector of values to remove from final table (e.g. DK/Ref).
#' This will not affect any calculations made. The vector is not case-sensitive.
#' @param n logical, if TRUE a column of row totals is included
#' @param pct_type Controls the kind of percentage values returned. One of "row," "cell," or "column."
#' @param format one of "long" or "wide"
#' @param ... further arguments passed to pollster::crosstab, such as unwt_n
#'
#' @return A tibble
#' @export
#'
#' @examples
#' time_series(integ, g40)
#'
time_series <- function(mulaw, variable, date = zpollenddate, weight = zwave_weight,
                    remove = "", n = TRUE, pct_type = "row",
                    format = "wide", ...){
  pollster::crosstab(df = mulaw, x = {{date}}, y = {{variable}}, {{weight}}, remove = remove,
                     n = n, pct_type = pct_type, format = format, ... = ...)
}