R/kdest-print.R

In jpfrench81/smacpod: Statistical Methods for the Analysis of Case-Control Point Data

#' Print a \code{kdenv} object
#'
#' Print an \code{kdenv} object produced by
#' \code{\link[smacpod]{kdest}}.
#'
#' @param x An object produced by the
#'   \code{\link[smacpod]{kdest}} function.
#' @param ... Not currently implemented.
#' @param extra A logical value indicating whether extra
#'   information related to the internal
#'   \code{\link[spatstat.explore]{fv}} object should be printed.
#'   The default is \code{FALSE}.
#' @return Information about the \code{kdest}
#' @author Joshua French
#' @export
print.kdenv = function(x, ..., extra = FALSE) {
  cat("\nEnvelopes for difference in estimated K functions\n\n")
  cat("KD(r) = K_case(r) - K_control(r)\n")
  cat("case label: ", x$case_label, "\n")
  cat("control label: ", x$control_label, "\n")
  cat("KD(r) computed for r betwen ",
      x$rlim[1], "and", x$rlim[2], "\n")
  if (x$nsim > 0) {
    cat("number of simulations: ", x$nsim, "\n")
    cat("simulation procedure: random labeling\n")
    cat("envelope level: ", x$level, "\n")
  }
  if (extra) {
    x$out  
  }
}