accessors: LHS Accessor Functions.

Description Usage Arguments Details

Description

Instead of using the $ operator, using these accessor functions is the preferred method for accessing the data and result data frames from an LHS or PLUE object, as the internal structure of the object may vary between versions of the package.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
get.results(obj, get.mean = TRUE)

get.data(obj)

get.N(obj)

get.ninputs(obj)

get.noutputs(obj)

get.repetitions(obj)

Arguments

obj

The LHS or PLUE object

get.mean

In case of stochastic models, when several model runs are required for the same data point, the data slot of the LHS object contains all the model outputs. Use get.mean=TRUE to get the average values for each point, or get.mean=FALSE to get all the results.

Details

get.data returns a data.frame consisting on the input data.

get.results returns an array with the model results. See the vignette on multiple runs for details on the get.mean argument.

get.N, get.ninputs, get.noutputs return a single number each, with the number of points in the hypercube (or sampling), number of input factors and number of response variables.

get.repetitions returns the number of model repetitions for each data point, created by LHS(model, factors, N, repetitions=X), or by telling several result sets to the same LHS object (or PLUE object).


pse documentation built on May 2, 2019, 12:56 a.m.