R/summary.rdp.R

In rddapp: Regression Discontinuity Design Application

#' Summarize the Power Analysis of Regression Discontinuity
#' 
#' \code{summary.rdp} is a \code{summary} method for class \code{"rdp"}.
#' It is based on \code{summary.RD} function in the "rdd" package.
#' 
#' @method summary rdp
#' 
#' @param object An object of class \code{"rdp"}, usually a result of a call to \code{\link{rd_power}}.
#' @param digits A non-negative integer specifying the number of digits to display.
#'   The default is \code{max(3, getOption("digits") - 3)}.
#' @param ... Additional arguments passed to \code{summary}.
#' 
#' @return \code{summary.rdp} returns a list which has the following components:
#' \item{coefficients}{A matrix containing the mean, variance, and empirical alpha of each estimator.}
#'
#' @references Drew Dimmery (2016). rdd: Regression Discontinuity Estimation. R package
#'    version 0.57. https://CRAN.R-project.org/package=rdd
#'
#' @include rd_power.R
#' 
#' @export

summary.rdp <- function(object, digits = max(3, getOption("digits") - 3), ...) {

  colnames(object) = c("Repetitions", "Mean", "Std. Error", 
                       paste("alpha = ", as.numeric(colnames(object)[4:ncol(object)])*100, "%", sep = ''))
  object[, "Std. Error"] = sqrt(object[, "Std. Error"])
  
  outmat <- apply(object, 2, function(x) format(x, digits = digits))
  
  cat("Estimates:\n")
  print.default(outmat, quote = FALSE, print.gap = 2, right = FALSE)

  out <- list(coefficients = unclass(object))
  
  return(invisible(out))
}