R/tango-print.R

In jfrench/smerc: Statistical Methods for Regional Counts

#' Print object of class \code{tango}.
#'
#' Print a \code{tango} object. If the \code{crayon} package
#' is installed, then the results are printed in color.
#'
#' @param x An object of class \code{tango}.
#' @param digits Number of significant digits to print.
#' @param \dots Not currently implemented.
#' @export
#' @examples
#' data(nydf)
#' coords <- as.matrix(nydf[, c("x", "y")])
#' w <- dweights(coords, kappa = 1)
#' results <- tango.test(nydf$cases, nydf$pop, w, nsim = 49)
#' results
print.tango <- function(x, ..., digits = 2) {
  if (requireNamespace("crayon", quietly = TRUE)) {
    print_tango_crayon(x, digits)
  } else {
    cat("method: Tango's index\n")
    index <- base::signif(x$tstat, digits = digits)
    gof <- base::signif(x$gof, digits = digits)
    sa <- base::signif(x$sa, digits = digits)
    tstat_chisq <- base::signif(x$tstat.chisq, digits = digits)
    dfc <- base::signif(x$dfc, digits = digits)
    pvalue_chisq <- base::signif(x$pvalue.chisq, digits = digits)

    cat(paste("index:", index), sep = "\n")
    cat(paste("goodness-of-fit component:", gof), sep = "\n")
    cat(paste("spatial autocorrelation component:", sa), sep = "\n")
    cat(paste("chi-square statistic:", tstat_chisq), sep = "\n")
    cat(paste("chi-square df:", dfc), sep = "\n")
    cat(paste("chi-square p-value:", pvalue_chisq), sep = "\n")
    if (!is.null(x$pvalue.sim)) {
      pvalue_sim <- base::signif(x$pvalue.sim, digits = digits)
      cat(paste("Monte Carlo p-value:", pvalue_sim), sep = "\n")
    }
  }
}

#' Print tango object in color
#'
#' Print tango object in color using crayon package
#'
#' @param x tango object
#' @param digits Number of significant digits
#' @return NULL
#' @noRd
print_tango_crayon <- function(x, digits) {
  message(paste(
    crayon::blue("method:"),
    crayon::magenta("Tango's index")
  ))
  index <- base::signif(x$tstat, digits = digits)
  gof <- base::signif(x$gof, digits = digits)
  sa <- base::signif(x$sa, digits = digits)
  tstat_chisq <- base::signif(x$tstat.chisq, digits = digits)
  dfc <- base::signif(x$dfc, digits = digits)
  pvalue_chisq <- base::signif(x$pvalue.chisq, digits = digits)

  message(paste(
    crayon::blue("index:"),
    crayon::magenta(index)
  ))
  message(paste(
    crayon::blue("goodness-of-fit component:"),
    crayon::magenta(gof)
  ))
  message(paste(
    crayon::blue("spatial autocorrelation component:"),
    crayon::magenta(sa)
  ))
  message(paste(
    crayon::blue("chi-square statistic:"),
    crayon::magenta(tstat_chisq)
  ))
  message(paste(
    crayon::blue("chi-square df:"),
    crayon::magenta(dfc)
  ))
  message(paste(
    crayon::blue("chi-square p-value:"),
    crayon::magenta(pvalue_chisq)
  ))
  if (!is.null(x$pvalue.sim)) {
    pvalue_sim <- base::signif(x$pvalue.sim, digits = digits)
    message(paste(
      crayon::blue("Monte Carlo p-value:"),
      crayon::magenta(pvalue_sim)
    ))
  }
}