R/summary.caribouSim.R

In chrisroberts2112/msProject: Functions for evaluating Rivest Estimator

#' Summary function
#'
#' This is a summary function for the class "caribouSim"
#'
#' @param x Object of class "caribouSim'
#'
#' @export
#'

summary.caribouSim <- function(x, ...){
  cat("Out of", nrow(x$collars), "simulations, \n")
  cat("The Fisher's exact test had a rejections rate of ", x$reject_rate[1], "\n")
  cat("and the overdispersion test had a rejection  rate of ", x$reject_rate[2])
  cat("\n \n")
  cat("The mean number of missing collars is", mean(x$collars[,1] - x$collars[,2]))
  cat("\n \n")
  cat("The mean error in estimated population size is", mean(abs(x$abundance[,4])))
  cat(" (", mean(abs(x$abundance[,5])), "%) with a standard deviation of", sd(x$abundance[,4]))
}