tidyBDMethod: Tidy BDMethod Data

In areyesq89/SummarizedBenchmark: Classes and methods for performing benchmark comparisons

Description

A helper function to extract information for a single or multiple BDMethod object or a list of BDMethod objects.

Usage

tidyBDMethod(obj, dat = NULL, eval = FALSE, label = FALSE)

## S4 method for signature 'BDMethod'
tidyBDMethod(obj, dat, eval)

## S4 method for signature 'list'
tidyBDMethod(obj, dat = NULL, eval = FALSE,
  label = FALSE)

## S4 method for signature 'SimpleList'
tidyBDMethod(obj, dat = NULL, eval = FALSE,
  label = FALSE)

## S4 method for signature 'BenchDesign'
tidyBDMethod(obj, dat = NULL, eval = FALSE,
  label = FALSE)

Arguments

obj	BDMethod object, list/List of BDMethod objects (e.g. a BDMethodList), or a BenchDesign object
dat	optional data object to use when evaluating any unevaluated expressionsin bdm meta data. (default = NULL)
eval	logical whether to evaluate any quosures in the meta slot of the BDMethod objects. (default = FALSE)
label	logical whether to add a "label" column to the resulting table containing the names of the methods if obj was specified as a named list. (default = FALSE)

Details

If any quosures are specified to the "meta" slot of a BDMethod object, the quosure is converted to a text string using rlang::quo_text.

Value

A named vector of meta data if only a single BDMethod object specified, else a tibble of meta data for the specified list of methods.

Author(s)

Patrick Kimes

areyesq89/SummarizedBenchmark documentation built on Sept. 2, 2021, 4:15 p.m.