1% Generated by roxygen2: do not edit by hand
2% Please edit documentation in R/deprec-bench-compare.r
3\name{bench_compare}
4\alias{bench_compare}
5\alias{bench_tbls}
6\alias{compare_tbls}
7\alias{compare_tbls2}
8\alias{eval_tbls}
9\alias{eval_tbls2}
10\title{Evaluate, compare, benchmark operations of a set of srcs.}
11\usage{
12bench_tbls(tbls, op, ..., times = 10)
13
14compare_tbls(tbls, op, ref = NULL, compare = equal_data_frame, ...)
15
16compare_tbls2(tbls_x, tbls_y, op, ref = NULL, compare = equal_data_frame, ...)
17
18eval_tbls(tbls, op)
19
20eval_tbls2(tbls_x, tbls_y, op)
21}
22\arguments{
23\item{tbls, tbls_x, tbls_y}{A list of \code{\link[=tbl]{tbl()}}s.}
24
25\item{op}{A function with a single argument, called often with each
26element of \code{tbls}.}
27
28\item{\dots}{For \code{compare_tbls()}: additional parameters passed on the
29\code{compare()} function
30
31For \code{bench_tbls()}: additional benchmarks to run.}
32
33\item{times}{For benchmarking, the number of times each operation is
34repeated.}
35
36\item{ref}{For checking, a data frame to test results against. If not
37supplied, defaults to the results from the first \code{src}.}
38
39\item{compare}{A function used to compare the results. Defaults to
40\code{equal_data_frame} which ignores the order of rows and columns.}
41}
42\value{
43\code{eval_tbls()}: a list of data frames.
44
45\code{compare_tbls()}: an invisible \code{TRUE} on success, otherwise
46an error is thrown.
47
48\code{bench_tbls()}: an object of class
49\code{\link[microbenchmark:microbenchmark]{microbenchmark::microbenchmark()}}
50}
51\description{
52\Sexpr[results=rd, stage=render]{lifecycle::badge("deprecated")}
53These functions are deprecated because we now believe that you're
54better of performing the comparisons directly, yourself, in order to
55generate more informative test failures.
56}
57\keyword{internal}
58