expCreate: Load data and create an exreport experiment

In exreport: Fast, Reliable and Elegant Reproducible Research

Description

This function loads a data.frame, checks its properties and formats an exreport experiment object. The columns of an experiments must contain at least two categorical columns to be identified as the method and problem variables and a thrid numerical column to be identified as an output variable. Additional columns can be added as parameters or additional outputs.

Usage

expCreate(data, methods = "method", problems = "problem",
  parameters = c(), respectOrder = FALSE, name, tol = 1e-09)

Arguments

data	A data.frame object satisfying the experiment format
methods	The name of the variable which contains the methods, by default is searches for a column named "method".
problems	The name of the variable which contains the problems, by default is searches for a column named "problem".
parameters	A list of the columns names to be identified as parameters. By default the remaining categorical columns are identified as parameters, so this list is useful only to identify numeric columns.
respectOrder	A logical parameter which indicates if the order of the elements of the method and problem columns must be respected by appearance or ordered alphabeticaly. It affects to the look of data representations.
name	A string which will identify the experiment in the report.
tol	Tolerance factor to identify repeated experiments for duplicated rows.

Value

A new exreport experiment object.

See Also

expCreateFromTable

Examples

# Creates experiment specifying column names and the numerical variables that
# are parameters

expCreate(wekaExperiment,
methods="method",
problems="problem",
parameters="fold",
name="Test Experiment")

exreport documentation built on May 1, 2019, 10:13 p.m.