From 57c106969c9d60fd7c854bf16e61ed67ee0383ea Mon Sep 17 00:00:00 2001 From: Toby Dylan Hocking Date: Wed, 17 Apr 2024 23:52:27 -0700 Subject: [PATCH] more.units ->unit.col.vec --- man/atime.Rd | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/man/atime.Rd b/man/atime.Rd index 1a0dd5d..d96d091 100644 --- a/man/atime.Rd +++ b/man/atime.Rd @@ -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.} @@ -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}