% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/summary_methods.R
\name{summary.gg}
\alias{summary.gg}
\alias{print.summary.gg}
\alias{summary.gg_error}
\alias{summary.gg_vimp}
\alias{summary.gg_rfsrc}
\alias{summary.gg_variable}
\alias{summary.gg_partial}
\alias{summary.gg_partial_rfsrc}
\alias{summary.gg_partialpro}
\alias{summary.gg_partial_varpro}
\alias{summary.gg_roc}
\alias{summary.gg_survival}
\alias{summary.gg_varpro}
\alias{summary.gg_udependent}
\alias{summary.gg_brier}
\alias{summary.gg_isopro}
\alias{summary.gg_beta_varpro}
\alias{summary.gg_ivarpro}
\title{Summary methods for gg_* data objects}
\usage{
\method{print}{summary.gg}(x, ...)

\method{summary}{gg_error}(object, ...)

\method{summary}{gg_vimp}(object, ...)

\method{summary}{gg_rfsrc}(object, ...)

\method{summary}{gg_variable}(object, ...)

\method{summary}{gg_partial}(object, ...)

\method{summary}{gg_partial_rfsrc}(object, ...)

\method{summary}{gg_partialpro}(object, ...)

\method{summary}{gg_partial_varpro}(object, ...)

\method{summary}{gg_roc}(object, ...)

\method{summary}{gg_survival}(object, ...)

\method{summary}{gg_varpro}(object, ...)

\method{summary}{gg_udependent}(object, ...)

\method{summary}{gg_brier}(object, ...)

\method{summary}{gg_isopro}(object, ...)

\method{summary}{gg_beta_varpro}(object, ...)

\method{summary}{gg_ivarpro}(object, ...)
}
\arguments{
\item{x}{A \code{summary.gg} object (for \code{print.summary.gg}).}

\item{...}{Not currently used.}

\item{object}{A \code{gg_*} data object.}
}
\value{
A \code{summary.gg} object: a list with \code{header} and
\code{body} character vectors. \code{print.summary.gg} returns it
invisibly.
}
\description{
Where \code{print} gives you a one-line header, \code{summary} digs a level
deeper. Each \code{summary.gg_*()} method returns a \code{summary.gg}
object: a header line plus a few diagnostic statistics for that object
type (the OOB error curve, the top VIMP variables, a time range, the
integrated CRPS, and so on). \code{print.summary.gg()} renders it to the
console.
}
\examples{
set.seed(42)
airq <- na.omit(airquality)
rf <- randomForestSRC::rfsrc(Ozone ~ ., data = airq, ntree = 50)
summary(gg_error(rf))
summary(gg_vimp(rf))

}
\seealso{
\code{\link{print.gg}}, \code{\link{autoplot.gg}}
}
