R/summary.initValOW.R

In RelDists: Estimation for some Reliability Distributions

#' Summary of \code{initValOW} objects
#' 
#' @description 
#' This \code{summary} method displays initial values and search regions
#' for \code{\link{OW}} family.
#' 
#' @aliases summary.initValOW
#' 
#' @author Jaime Mosquera Gutiérrez \email{jmosquerag@unal.edu.co}
#' 
#' @param object an object of class \code{initVal}, generated with 
#'               \code{\link{initValuesOW}}.
#' @param ... extra arguments
#' 
#' @return 
#' No return value, it just prints out in the console the initial values and the
#' search regions for \eqn{sigma} and \eqn{nu} from OW distribution (see 
#' \code{\link{dOW}}).
#'              
#' @export   
summary.initValOW <- function(object, ...){
  cat("--------------------------------------------------------------------\n")
  cat("Initial Values\n")
  cat(paste0("sigma = ", object$sigma.start, "\n"))
  cat(paste0("nu = ", object$nu.start, "\n"))
  cat("--------------------------------------------------------------------\n")
  cat("Search Regions\n")
  cat("For sigma: ")
  cat(paste0(object$sigma.valid, "\n"))
  cat("For nu: ")
  cat(paste0(object$nu.valid, "\n"))
  cat("--------------------------------------------------------------------\n")
  cat("Hazard shape: ")
  cat(object$hazard_type)
  if ( !is.null(object$warning) ) warning(object$warning)
}