\HeaderA{monomvn.s3}{Summarizing monomvn output}{monomvn.s3}
\aliasA{plot.summary.monomvn}{monomvn.s3}{plot.summary.monomvn}
\aliasA{print.monomvn}{monomvn.s3}{print.monomvn}
\aliasA{print.summary.monomvn}{monomvn.s3}{print.summary.monomvn}
\aliasA{summary.monomvn}{monomvn.s3}{summary.monomvn}
\keyword{methods}{monomvn.s3}
\keyword{hplot}{monomvn.s3}
\begin{Description}\relax
Summarizing, printing, and plotting the contents of a
\code{"monomvn"}-class object
\end{Description}
\begin{Usage}
\begin{verbatim}
## S3 method for class 'monomvn':
summary(object, Si = FALSE, ...)
## S3 method for class 'summary.monomvn':
print(x, ...)
## S3 method for class 'summary.monomvn':
plot(x, gt0 = FALSE, main = NULL,
     xlab = "number of zeros", ...)
\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\code{object}] a \code{"monomvn"}-class object that must be named
\code{object} for the generic methods \code{\LinkA{summary.monomvn}{summary.monomvn}} 
\item[\code{x}] a \code{"monomvn"}-class object that must be named \code{x}
for generic printing and plotting via
\code{\LinkA{print.summary.monomvn}{print.summary.monomvn}} and
\code{\LinkA{plot.summary.monomvn}{plot.summary.monomvn}} 
\item[\code{Si}] boolean indicating whether \code{object\$S} should be
inverted and inspected for zeros within
\code{\LinkA{summary.monomvn}{summary.monomvn}}, indicating pairwise independence;
default is \code{FALSE} 
\item[\code{gt0}] boolean indicating whether the histograms in
\code{\LinkA{plot.summary.monomvn}{plot.summary.monomvn}} should exclude columns
of \code{object\$S} or \code{Si} without any zero entries 
\item[\code{main}] optional text to be added to the main title of the histograms
produced by the generic \code{\LinkA{plot.summary.monomvn}{plot.summary.monomvn}} 
\item[\code{xlab}] label for the x-axes of the histograms produced by
\code{\LinkA{plot.summary.monomvn}{plot.summary.monomvn}}; otherwise default
automatically-generated text is used 
\item[\code{...}] passed to \code{\LinkA{print.monomvn}{print.monomvn}}, or
\code{\LinkA{plot.default}{plot.default}}
\end{ldescription}
\end{Arguments}
\begin{Details}\relax
These functions work on the output from both \code{\LinkA{monomvn}{monomvn}}
and \code{\LinkA{bmonomvn}{bmonomvn}}.

\code{\LinkA{print.monomvn}{print.monomvn}} prints the \code{call} followed by a
summary of the regression  method used at each iteration of the
algorithm.  It also indicates how many completely observed features
(columns) there were in the data.
For non-least-squares regressions (i.e., \pkg{plsr}, \pkg{lars}
and \code{\LinkA{lm.ridge}{lm.ridge}} methods)
and indication of the method used for selecting the
number of components (i.e., \code{CV}, \code{LOO}, etc., or
\code{none}) is provided

\code{\LinkA{summary.monomvn}{summary.monomvn}} summarizes information about the
number of zeros in the estimated covariance matrix \code{object\$S}
and its inverse

\code{\LinkA{print.summary.monomvn}{print.summary.monomvn}} calls \code{\LinkA{print.monomvn}{print.monomvn}}
on the \code{object} and then prints the result of
\code{\LinkA{summary.monomvn}{summary.monomvn}}

\code{\LinkA{plot.summary.monomvn}{plot.summary.monomvn}} makes histograms of the number of
zeros in the columns of \code{object\$S} and its inverse
\end{Details}
\begin{Value}
\code{\LinkA{summary.monomvn}{summary.monomvn}} returns a
\code{"summary.monomvn"}-class object, which is a \code{list}
containing (a subset of) the items below.  The other
functions do not return values.

\begin{ldescription}
\item[\code{obj}] the \code{"monomvn"}-class \code{object} 
\item[\code{marg}] the proportion of zeros in \code{object\$S} 
\item[\code{S0}] a vector containing the number of zeros in each column
of \code{object\$S} 
\item[\code{cond}] if input \code{Si = TRUE} this field contains the
proportion of zeros in the inverse of \code{object\$S} 
\item[\code{Si0}] if input \code{Si = TRUE} this field contains a
vector with the number of zeros in each column of the inverse
of \code{object\$S} 
\end{ldescription}
\end{Value}
\begin{Note}\relax
There is one further S3 function for \code{"monomvn"}-class
objects that has its own help file: \code{\LinkA{plot.monomvn}{plot.monomvn}}
\end{Note}
\begin{Author}\relax
Robert B. Gramacy \email{bobby@statslab.cam.ac.uk}
\end{Author}
\begin{References}\relax
\url{http://www.statslab.cam.ac.uk/~bobby/monomvn.html}
\end{References}
\begin{SeeAlso}\relax
\code{\LinkA{bmonomvn}{bmonomvn}}, \code{\LinkA{monomvn}{monomvn}},
\code{\LinkA{plot.monomvn}{plot.monomvn}}
\end{SeeAlso}

