R/tidy.R

In grantmcdermott/ritest: Randomisation Inference Testing

#' @importFrom generics tidy
#' @export
generics::tidy

#' Tidy an `ritest` object
#'
#' @param x An object produced by the `ritest` function.
#' @param conf.int Logical indicating whether or not to include a confidence
#'   interval.
#' @inheritParams ritest
#' @return A data frame of summary statistics that conforms to the `broom`
#'   package specifications.
#' @export
#' @examples
#' est = lm(yield ~ N + P + K, data = npk)
#' est_ri = ritest(est, 'N', reps = 1e3, seed = 1234L, pcores = 2L)
#' tidy(est_ri)
#' glance(est_ri)
tidy.ritest <- function(x,
                        conf.int = TRUE,
                        ...) {

  ret = data.frame(term = x$resampvar,
                   estimate = x$beta_parm,
                   std.error = x$se,
                   p.value = as.numeric(x$pval))

  # confidence intervals
  if (conf.int) {
    ci = x$ci
    if (attr(x$pval, 'side')=='<=') ci[2] = Inf
    if (attr(x$pval, 'side')=='>=') ci[1] = -Inf
    ret$conf.low = ci[1]
    ret$conf.high = ci[2]
  }

  return(ret)
}


#' @importFrom generics glance
#' @export
generics::glance

#' Glance at an `ritest` object
#'
#' @return A data frame of goodness-of-fit statistics that conforms to the
#'   `broom` package specifications.
#' @inherit tidy.ritest params examples
#' @export
glance.ritest <- function(x, ...) {
  ret = data.frame(H0 = x$h0, Num.Reps = sprintf("%s", x$reps))
  if (!is.null(x$strata)) ret$Strata = x$strata
  if (!is.null(x$cluster)) ret$Clusters = x$cluster
  return(ret)
}