\HeaderA{summary.tsp}{Summary of a tsp object}{summary.tsp}
\aliasA{summary}{summary.tsp}{summary}
\keyword{misc}{summary.tsp}
\begin{Description}\relax
This function can be used to summarize a TSP object.
\end{Description}
\begin{Usage}
\begin{verbatim}
  ## S3 method for class 'tsp':
  summary(object,select=NULL,printall=FALSE,...)
\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\code{object}] A tsp object
\item[\code{select}] A numerical indicator of which TSP to summarize, if NULL, all TSPs are summarized one at a time
\item[\code{printall}] If printall=TRUE all TSPs are summarized at once
\item[\code{...}] Summary arguments (ignored)
\end{ldescription}
\end{Arguments}
\begin{Details}\relax
summary() accepts a tsp object calculated on an expression set
or gene expression matrix. The result is a table of frequencies for
the TSP indicator versus the group indicator.
\end{Details}
\begin{Value}
A table.
\end{Value}
\begin{Author}\relax
Jeffrey T. Leek \email{jtleek@jhu.edu}
\end{Author}
\begin{References}\relax
D. Geman, C. d'Avignon, D. Naiman and R. Winslow, "Classifying gene expression profiles from pairwise mRNA comparisons," 
Statist. Appl. in Genetics and Molecular Biology, 3, 2004.
\end{References}
\begin{SeeAlso}\relax
\code{\LinkA{tspplot}{tspplot}}, \code{\LinkA{ts.pair}{ts.pair}}, \code{\LinkA{tspcalc}{tspcalc}},\code{\LinkA{tspsig}{tspsig}}, \code{\LinkA{predict.tsp}{predict.tsp}}
\end{SeeAlso}
\begin{Examples}
\begin{ExampleCode}
  ## Not run: 
  ## Load data
  data(tspdata) 

  ## Run tspcalc() on a data matrix and grp vector
  tsp1 <- tspcalc(dat,grp)

  ## Get the summary for the tsp object. 
  summary(tsp1)
  summary.tsp(tsp1)
 ## End(Not run)
\end{ExampleCode}
\end{Examples}

