Skip to content

Commit

Permalink
more.units ->unit.col.vec
Browse files Browse the repository at this point in the history
  • Loading branch information
tdhock committed Apr 18, 2024
1 parent 041a784 commit 57c1069
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions man/atime.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@
\title{Asymptotic timing}
\description{Computation time and memory for several R expressions of
several different data sizes.}

\usage{atime(
N, setup, expr.list=NULL, times=10, seconds.limit=0.01, verbose=FALSE,
result=FALSE, ...)}

\arguments{
\item{N}{numeric vector of at least two data sizes, default is \code{2^seq(2,20)}.}
\item{setup}{expression to evaluate for every data size, before timings.}
Expand All @@ -16,16 +18,17 @@ result=FALSE, ...)}
\item{verbose}{logical, print messages after every data size?}
\item{result}{logical, save each result? If \code{TRUE}, and result is
a data frame with one row, then the numeric column names will be
saved, for use as the default \code{more.units} argument to
\code{\link{references_best}}.}
saved as more units to analyze (in addition to kilobytes and seconds).}
\item{\dots}{named expressions to time.}
}

\details{Each iteration involves first computing the setup expression,
and then computing several times the \dots expressions. For
convenience, expressions may be specified either via code (\dots) or
data (\code{expr.list} arg).}
\value{list of class atime with elements \code{more.units} (character
vector of unit column names), \code{seconds.limit} (numeric

\value{list of class atime with elements \code{unit.col.vec} (character
vector of column names to analyze), \code{seconds.limit} (numeric
input param), \code{measurements} (data table of results).}

\author{Toby Dylan Hocking}
Expand Down

0 comments on commit 57c1069

Please sign in to comment.