dataset: dataset object constructor.

View source: R/class_dataset.R

datasetR Documentation

dataset object constructor.

Description

Creates a new instance of a 'dataset' object

Usage

dataset(
  X,
  Y,
  data.dir = getwd(),
  data.fname = "CalibrationData.txt",
  fname = "Config_Data.txt",
  Xu = NULL,
  Xb = NULL,
  Xb.indx = NULL,
  Yu = NULL,
  Yb = NULL,
  Yb.indx = NULL,
  VAR.indx = NULL
)

Arguments

X

data frame, observed input variables.

Y

data frame, observed output variables (same number of rows as X).

data.dir

Character, directory where a copy of the dataset will be written if required. Default is the current working directory, but you may prefer to use the BaM workspace.

data.fname

Character, data file name.

fname

Character, configuration file name.

Xu

data frame, random uncertainty in X, expressed as a standard deviation. Same dimension as X.

Xb

data frame, systematic uncertainty in X, expressed as a standard deviation. Same dimension as X.

Xb.indx

data frame, index of systematic errors in X. Same dimension as X.

Yu

data frame, random uncertainty in Y, expressed as a standard deviation. Same dimension as Y.

Yb

data frame, systematic uncertainty in Y, expressed as a standard deviation. Same dimension as Y.

Yb.indx

data frame, index of systematic errors in Y. Same dimension as Y.

VAR.indx

data frame, indices used for defining how VAR parameters vary.

Value

An object of class 'dataset'.

Examples

X=data.frame(input1=rnorm(100),input2=rnorm(100))
Y=data.frame(output=X$input1+0.8*X$input2+0.1*rnorm(100))
workspace=tempdir()
d <- dataset(X=X,Y=Y,data.dir=workspace)

BaM-tools/RBaM documentation built on April 11, 2025, 10:01 p.m.