The R Project SVN R

Rev

Rev 68948 | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 68948 Rev 85908
Line 6... Line 6...
6 
\name{gc.time}
 6 
\name{gc.time}
7 
\alias{gc.time}
 7 
\alias{gc.time}
8 
\title{Report Time Spent in Garbage Collection}
 8 
\title{Report Time Spent in Garbage Collection}
9 
\description{
 9 
\description{
10 
  This function reports the time spent in garbage collection so far in
 10 
  This function reports the time spent in garbage collection so far in
11 
  the \R session while GC timing was enabled.
 11 
  the \R session while \abbr{GC} timing was enabled.
12 
}
 12 
}
13 
\usage{
 13 
\usage{
14 
gc.time(on = TRUE)
 14 
gc.time(on = TRUE)
15 
}
 15 
}
16 
\arguments{
 16 
\arguments{
17 
  \item{on}{logical; if \code{TRUE}, GC timing is enabled.}
 17 
  \item{on}{logical; if \code{TRUE}, \abbr{GC} timing is enabled.}
18 
}
 18 
}
19 
\value{
 19 
\value{
20 
  A numerical vector of length 5 giving the user CPU time, the system
 20 
  A numerical vector of length 5 giving the user CPU time, the system
21 
  CPU time, the elapsed time and children's user and system CPU times
 21 
  CPU time, the elapsed time and children's user and system CPU times
22 
  (normally both zero), of time spent doing garbage collection whilst
 22 
  (normally both zero), of time spent doing garbage collection whilst
23 
  GC timing was enabled.
 23 
  \abbr{GC} timing was enabled.
24 
 
 24 
 
25 
  Times of child processes are not available on Windows and will always
 25 
  Times of child processes are not available on Windows and will always
26 
  be given as \code{NA}.
 26 
  be given as \code{NA}.
27 
}
 27 
}
28 
\details{
 28 
\details{