BDData {SummarizedBenchmark} | R Documentation

## Create a new BDData object

### Description

Initializes a new BDData object of benchmarking data.

Data sets are stored as BDData objects within BenchDesign objects as well as SummarizedBenchmark objects. However, because data is directly specified to the BenchDesign constructor, there is usually no need to call the BDData constructor to create completely new data objects.

The BDData constructor is most useful for extracting the data sets contained in BenchDesign objects as well as SummarizedBenchmark objects. By default, the BDData object stored in SummarizedBenchmark objects will be MD5 hashes rather than the complete original data set. `compareBDData` can be used to compare various forms of BDData, as shown in the examples below.

### Usage

    BDData(data)

    ## S4 method for signature 'ANY'
    BDData(data)

    ## S4 method for signature 'BenchDesign'
    BDData(data)

    ## S4 method for signature 'SummarizedBenchmark'
    BDData(data)

    ## S4 method for signature 'BDData'
    BDData(data)

### Arguments

`data` | a list object of data or MD5 hash string

### Value

BDData object

### Author(s)

Patrick Kimes

### See Also

`BDData-class`, `BenchDesign`

### Examples

    ## construct from data.frame
    datadf <- data.frame(x = 1:5, y = runif(5))
    bdd_df <- BDData(datadf)
    bdd_df

    ## construct from MD5 hash of data.frame
    bdd_md5 <- BDData(digest::digest(datadf))
    bdd_md5

    ## compare two BDData objects
    compareBDData(bdd_df, bdd_md5)

    ## note that the data is the same, i.e. the MD5 hashes match, but the
    ## data types ("data" vs. "md5has") are different

[Package SummarizedBenchmark version 2.5.0 Index]