R/print.hci.R

In rineq: Concentration Index and Decomposition for Health Inequalities

#' Prints an `hci` object.
#' @param x  Object of type `hci`
#' @param ... Currently unused
#' @return Invisibly returns `x` as the function is called for side effects. 
#' @export
#' 
#' @examples
#' data(housing)
#' ci.bmi <- ci(ineqvar = housing$income, outcome = housing$bmi, method = "direct")
#' print(ci.bmi)
#' 
print.hci <-
function(x, ...) {
  if (!inherits(x,"hci")) stop("Object is not of class hci")
  print(x$concentration_index)
  
  # return X since its a base-style plot function (https://adv-r.hadley.nz/functions.html) called for side effects    
  invisible(x)
}