R/betareg.R

In deepfriar/wickr: Summarises all

#' @describeIn tidify \code{margins} plays strangely with \code{betareg} objects; this method works around those quirks
#' @param data data.frame. Where is the data located? Defaults to data within the model object.
#' @param variables character. Which terms to get effects for. Default \code{NULL} (\[everyone.gif\]).
#' @export
tidify.betareg <- function(x, margins=FALSE, data=if(is.null(x$model)) {margins::find_data(x)} else {x$model}, variables=NULL, ...) {
  varlabels <- attr(stats::terms(x), "term.labels")
  variables <- if(is.null(variables)) {varlabels} else {intersect(variables, varlabels)}
  variables <- variables[!stringr::str_detect(variables, ":")]

  # NextMethod("tidify", x, margins=margins, variables=variables, ...)
  # does NextMethod fail to pass args not named in the next method?
  tidify.default(x, margins=margins, data=data, variables=variables, ...)
}

#' @describeIn encomp non-trivial method for \code{betareg} objects
#' @export
encomp.betareg <- function(x, y, ...) {
  y <- dplyr::mutate(y, component = ifelse(stringr::str_detect(.data$term, "^\\(phi"), "precision", "mean"))
  y <- dplyr::mutate(y, term      = stringr::str_remove(.data$term, "^\\(phi\\)_"))
  y <- dplyr::group_by(y, .data$component, .data$term)
  y <- suppressMessages(dplyr::select(y, .data$estimate, .data$std.error, .data$statistic, .data$p.value))

  y
}

#' @describeIn ascribe residual df, AIC, BIC, link, and n
#' @export
ascribe.betareg <- function(x, ...) {
  z <- list(df.residual=stats::df.residual, AIC=stats::AIC, BIC=stats::BIC, n=stats::nobs)
  z <- lapply(z, function(i) {i(x)})

  z$link         <- x$link$mean$name
  z$`link (phi)` <- x$link$precision$name

  z
}

# TODO is this an okay DRY way to remove pre-tidyverse dependencies?
#' @describeIn unlevel \code{levels$full} replaces \code{xlevels}
#' @export
unlevel.betareg <- function(x, ...) {
  # w <- reshape2::melt(x$levels$full, value.name="level", level="term")

  # w$term <- paste0(w$Lterm, w$level)

  # TODO: what did this line do? I can't figure it out
  # w$term <- stringr::str_replace(w$term, stringr::fixed("(phi)_"), "phi | ")

  # as.data.frame(w)

  x$xlevels <- x$levels$full
  NextMethod("unlevel", x, ...)
}