R/print.R

In jolars/prague: Generalized Linear Models Regularized with the Sorted L1-Norm

#' Print results from owl fit
#'
#' @param x an object of class `'Owl'` or `'TrainedOwl'`
#' @param ... other arguments passed to [print()]
#'
#' @return Prints output on the screen
#'
#' @examples
#' fit <- owl(wine$x, wine$y, family = "multinomial")
#' print(fit, digits = 1)
#'
#' @method print Owl
#' @export
print.Owl <- function(x, ...) {
  sigma <- x$sigma
  n_nonzero <- apply(x$nonzeros, 3, sum)
  deviance_ratio <- x$deviance_ratio

  out <- data.frame(sigma = sigma,
                    deviance_ratio = deviance_ratio,
                    n_nonzero = n_nonzero)

  # print call
  cat("\nCall:\n",
      paste(deparse(x$call), sep = "\n", collapse = "\n"),
      "\n\n", sep = "")

  # print path summary
  cat("\nPath summary:\n")
  print(out, ...)
}

#' @rdname print.Owl
#' @method print TrainedOwl
#' @export
print.TrainedOwl <- function(x, ...) {
  cat("\nCall:\n", paste(deparse(x$call), sep = "\n", collapse = "\n"),
      "\n\n", sep = "")

  cat("Optimum values:\n")

  print(x$optima, ...)
}