\HeaderA{gc.time}{Report Time Spent in Garbage Collection}{gc.time}
\keyword{utilities}{gc.time}
\begin{Description}\relax
This function reports the time spent in garbage collection so far in
the \R{} session while GC timing was enabled.
\end{Description}
\begin{Usage}
\begin{verbatim}
gc.time(on = TRUE)
\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\code{on}] logical; if \code{TRUE}, GC timing is enabled.
\end{ldescription}
\end{Arguments}
\begin{Value}
A numerical vector of length 5 giving the user CPU time, the system
CPU time, the elapsed time and children's user and system CPU times
(normally both zero), of time spent doing garbage collection whilst
GC timing was enabled.
\end{Value}
\begin{Section}{Warnings}
This is experimental functionality, likely to be removed as soon as
the next release.

The timings are rounded up by the sampling interval for timing
processes, and so are likely to be over-estimates.

It is a \LinkA{primitive}{primitive} and so ignores any argument name.
\end{Section}
\begin{SeeAlso}\relax
\code{\LinkA{gc}{gc}},
\code{\LinkA{proc.time}{proc.time}} for the timings for the session.
\end{SeeAlso}
\begin{Examples}
\begin{ExampleCode}
gc.time()
\end{ExampleCode}
\end{Examples}

