% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/methods.R
\name{summary.SCREENING}
\alias{summary.SCREENING}
\title{Summary method for the 'SCREENING' object}
\usage{
\method{summary}{SCREENING}(object, coef = 1L, top = 5L, p_level = 0.05, ...)
}
\arguments{
\item{object}{A \code{SCREENING} object.}

\item{coef}{For a \code{screen_beta} screening, which coefficient row to use
(default 1, the alpha).}

\item{top}{Number of best/worst funds to display. Default: 5.}

\item{p_level}{Significance level for the win/loss counts (used only when the
object carries square \code{pval}/\code{tstat} matrices). Default: 0.05.}

\item{...}{Further arguments (ignored).}
}
\value{
An object of class \code{summary.SCREENING}.
}
\description{
Produces a ranked summary of a screening: distribution of the
performance measure, the peer performance ratios, optional win/loss counts
from the pairwise tests, and the top/bottom funds (overall and by
out-/underperformance ratio). The win/loss counts require the square
(within-group) pairwise matrices and are therefore omitted for cross-group
screenings (a \code{Y} peer group or \code{\link{targetPeerPerformance}}).
Originally contributed by Murilo Andre Peres Pereira.
}
\examples{
\donttest{
  data("hfdata")
  sc <- alphaScreening(hfdata[, 1:10], control = list(nCore = 1))
  summary(sc)
}
}
\seealso{
\code{\link{alphaScreening}}.
}
\author{
Murilo Andre Peres Pereira, David Ardia and Kris Boudt.
}
\keyword{htest}
