R/print.senSlope.R

In USGS-R/smwrStats: R functions to support statistical methods in water resources

#' Print Objects
#' 
#' Prints the results of a Sen slope analysis (\code{senSlope}).
#' 
#' 
#' @param x an object of class "senSlope" from \code{senSlope}.
#' @param digits the number of significant digits to print numeric data.
#' @param \dots additonal arguments for printing numeric values.
#' @return The object \code{x} is returned invisibly.
#' @note The printed output contains the call, the smalles and largest
#' residuals, the regression coefficients, and the confidence limits of the Sen
#' slope.
#' @export
#' @method print senSlope
print.senSlope <- function(x, digits=4, ...) {
  ## Coding history:
  ##    2013Apr15 DLLorenz Original Coding
	##    2014Dec29 DLLorenz convert to roxygen header
  ##
  cat("Call:\n")
  dput(x$call)
  res <- sort(x$residuals) # get the actual residuals regardless of missing values
  cat("\nSmallest 5 residuals:\n")
  print(res[1:5], digits=digits, ...)
  cat("Largest 5 residuals:\n")
  print(rev(res)[1:5], digits=digits)
  cat("\nCoefficients:\n")
  coef <- x$coefficients
  names(coef) <- c("(Intercept)", x$var.name[2L])
  print(coef, digits=digits, ...)
  cat("Confidence interval for the Sen slope:\n")
  print(x$slope.CI)
  if(!is.null(x$na.action)) {
    n.na <- length(x$na.action)
    if(n.na > 1)
      cat("  (", n.na, " observations deleted due to missing values)\n", sep="")
    else
      cat("  (", n.na, " observation deleted due to missing values)\n", sep="")
  }
  cat("\n")
  invisible(x)
}