R/report_z.R

In Joe-Hilgard/hilgard: Miscellaneous Hilgard Convenience Functions

#' Report a z-test from a logistic regression model
#'
#' Report a z-test as z = z, p = .###, OR = OR [OR.LL, OR.UL].
#' @param model Model object from which to extract F-value.
#' @param effect Parameter with F-value of interest
#'
#' @export

report_z <- function(model, effect) {
  frame <- broom::tidy(model)
  z <- with(frame, statistic[term == effect])
  z <- round(z, 2)

  p <- with(frame, p.value[term == effect])
  p <- fix_p(p)

  OR <- with(frame, estimate[term == effect])
  OR <- exp(OR)
  OR <- round(OR, 2)

  ci <- confint(model)
  ci <- broom::tidy(ci)
  ci <- dplyr::filter(ci, .rownames == effect)
  ci <- dplyr::select(ci, -.rownames)
  ci <- exp(ci)
  ci <- round(ci, 2)

  output <- paste0("*z* = ", z, ", ", p, ", *OR* = ", OR, " [", ci[1], ", ", ci[2], "]")
  return(output)
}